The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Search-Query-Dialect-KSx-0.201
River stage one • 1 direct dependent • 2 total dependents
++
/ Search::Query::Dialect::KSx

NAME

Search::Query::Dialect::KSx - KinoSearch query dialect

SYNOPSIS

 my $query = Search::Query->parser( dialect => 'KSx' )->parse('foo');
 print $query;
 my $ks_query = $query->as_ks_query();
 my $hits = $ks_searcher->hits( query => $ks_query );

DESCRIPTION

Search::Query::Dialect::KSx extends the KinoSearch::QueryParser syntax to support wildcards, proximity and ranges, in addition to the standard Search::Query features.

METHODS

This class is a subclass of Search::Query::Dialect. Only new or overridden methods are documented here.

BUILD

Overrides base method and sets appropriate defaults. Can take the following params, also available as standard attribute methods.

wildcard

Default is '*'.

allow_single_wildcards

If true, terms like '*' and '?' are allowed as valid. If false, the Parser will croak if any term consists solely of a wildcard.

The default is false.

fuzzify

If true, a wildcard is automatically appended to each query term.

ignore_order_in_proximity

If true, the terms in a proximity query will be evaluated for matches regardless of the order in which they appear. For example, given a document excerpt like:

 foo bar bing

and a query like:

 "bing foo"~5

if ignore_order_in_proximity is true, the document would match. If ignore_order_in_proximity is false (the default), the document would not match.

stringify

Returns the Query object as a normalized string.

stringify_clause( leaf, prefix )

Called by stringify() to handle each Clause in the Query tree.

as_ks_query

Returns the Dialect object as a KinoSearch::Search::Query-based object. The Dialect object is walked and converted to a KinoSearch::Searcher-compatible tree.

field_class

Returns "Search::Query::Field::KSx".

AUTHOR

Peter Karman, <karman at cpan.org>

BUGS

Please report any bugs or feature requests to bug-search-query-dialect-ksx at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Search-Query-Dialect-KSx. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Search::Query::Dialect::KSx

You can also look for information at:

COPYRIGHT & LICENSE

Copyright 2010 Peter Karman.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.