/ 
KinoSearch-0.20_05
River stage two • 9 direct dependents • 10 total dependents
/ KinoSearch::QueryParser

NAME

KinoSearch::QueryParser - Transform a string into a Query object.

SYNOPSIS

my $query_parser = KinoSearch::QueryParser->new(
    schema => MySchema->new,
    fields => [ 'body' ],
);
my $query = $query_parser->parse( $query_string );
my $hits  = $searcher->search( query => $query );

DESCRIPTION

The QueryParser accepts UTF-8 search strings as input and produces Query objects, suitable for feeding into KinoSearch::Searcher.

Syntax

The following constructs are recognized by QueryParser.

  • Boolean operators 'AND', 'OR', and 'AND NOT'.

  • Prepented +plus and -minus, indicating that the labeled entity should be either required or forbidden -- be it a single word, a phrase, or a parenthetical group.

  • Logical groups, delimited by parentheses.

  • Phrases, delimited by double quotes.

Additionally, the following syntax can be enabled via set_heed_colons():

  • Field-specific terms, in the form of fieldname:termtext. (The field specified by fieldname will be used instead of the QueryParser's default fields).

    A field can also be given to a logical group, in which case it is the same as if the field had been prepended onto every term in the group. For example: foo:(bar baz) is the same as foo:bar foo:baz.

METHODS

new

my $query_parser = KinoSearch::QueryParser->new(
    schema         => MySchema->new,   # required
    analyzer       => $analyzer,       # overrides schema
    fields         => [ 'bodytext' ],  # default: indexed fields
    default_boolop => 'AND',           # default: 'OR'
);

Constructor. Takes hash-style parameters. Either searchable or analyzer must be supplied.

  • schema - An object which subclasses KinoSearch::Schema.

  • analyzer - An object which subclasses KinoSearch::Analysis::Analyzer. Ordinarily, the analyzers specified by each field's definition will be used, but if analyzer is supplied, it will override and be used for all fields. This can lead to mismatches between what is in the index and what is being searched for, so use caution.

  • fields - the names of the fields which will be searched against. By default, those fields which are defined as indexed in the supplied Schema.

  • default_boolop - two possible values: 'AND' and 'OR'. The default is 'OR', which means: return documents which match any of the query terms. If you want only documents which match all of the query terms, set this to 'AND'.

parse

my $query = $query_parser->parse( $query_string );

Turn a UTF-8 query string into a Query object. Depending on the contents of the query string, the returned object could be any one of several subclasses of KinoSearch::Search::Query.

set_heed_colons

$query_parser->set_heed_colons(1); # enable

Enable/disable special parsing of foo:bar constructs.

COPYRIGHT

Copyright 2005-2007 Marvin Humphrey

LICENSE, DISCLAIMER, BUGS, etc.

See KinoSearch version 0.20.