Search::Query::Dialect::KSx - KinoSearch query dialect
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 );
Search::Query::Dialect::KSx extends the KinoSearch::QueryParser syntax to support wildcards, proximity and ranges, in addition to the standard Search::Query features.
This class is a subclass of Search::Query::Dialect. Only new or overridden methods are documented here.
Overrides base method and sets appropriate defaults. Can take the following params, also available as standard attribute methods.
Default is '*'.
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.
If true, a wildcard is automatically appended to each query term.
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.
Returns the Query object as a normalized string.
Called by stringify() to handle each Clause in the Query tree.
Returns the Dialect object as a KinoSearch::Search::Query-based object. The Dialect object is walked and converted to a KinoSearch::Searcher-compatible tree.
Returns "Search::Query::Field::KSx".
Peter Karman, <karman at cpan.org>
<karman at cpan.org>
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.
bug-search-query-dialect-ksx at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Search::Query::Dialect::KSx
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Search-Query-Dialect-KSx
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Search-Query-Dialect-KSx
CPAN Ratings
http://cpanratings.perl.org/d/Search-Query-Dialect-KSx
Search CPAN
http://search.cpan.org/dist/Search-Query-Dialect-KSx/
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.
To install Search::Query::Dialect::KSx, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::Query::Dialect::KSx
CPAN shell
perl -MCPAN -e shell install Search::Query::Dialect::KSx
For more information on module installation, please visit the detailed CPAN module installation guide.