Search::OpenSearch::Engine::Lucy - Lucy server with OpenSearch results
use Search::OpenSearch::Engine::Lucy; my $engine = Search::OpenSearch::Engine::Lucy->new( index => [qw( path/to/index1 path/to/index2 )], facets => { names => [qw( color size flavor )], sample_size => 10_000, }, fields => [qw( color size flavor )], # result attributes in response indexer_config => { somekey => somevalue, }, searcher_config => { anotherkey => anothervalue, }, aggregator_class => 'MyAggregator', # defaults to SWISH::Prog::Aggregator cache => CHI->new( driver => 'File', dir_create_mode => 0770, file_create_mode => 0660, root_dir => "/tmp/opensearch_cache", ), cache_ttl => 3600, do_not_hilite => [qw( color )], snipper_config => { as_sentences => 1 }, # see Search::Tools::Snipper hiliter_config => { class => 'h', tag => 'b' }, # see Search::Tools::HiLiter parser_config => {}, # see Search::Query::Parser ); my $response = $engine->search( q => 'quick brown fox', # query s => 'rank desc', # sort order o => 0, # offset p => 25, # page size h => 1, # highlight query terms in results c => 0, # count total only (same as f=0 r=0) L => 'field|low|high', # limit results to inclusive range f => 1, # include facets r => 1, # include results t => 'XML', # or JSON u => 'http://yourdomain.foo/opensearch/', b => 'AND', # or OR ); print $response;
Passed as param to new(). This class is used for filtering incoming docs via the aggregator's swish_filter() method.
Overrides base method to load the aggregator_class and other Engine-specific construction tasks.
Returns a SWISH::Prog::Lucy::Searcher object.
Returns a SWISH::Prog::Lucy::Indexer object (used by the REST API).
Returns hash ref of facets from results. See Search::OpenSearch::Engine.
Overrides base method to preserve multi-value fields as arrays.
Returns true.
Peter Karman, <karman at cpan.org>
<karman at cpan.org>
Please report any bugs or feature requests to bug-search-opensearch-engine-lucy at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Search-OpenSearch-Engine-Lucy. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-search-opensearch-engine-lucy at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc Search::OpenSearch::Engine::Lucy
You can also look for information at:
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Search-OpenSearch-Engine-Lucy
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/Search-OpenSearch-Engine-Lucy
CPAN Ratings
http://cpanratings.perl.org/d/Search-OpenSearch-Engine-Lucy
Search CPAN
http://search.cpan.org/dist/Search-OpenSearch-Engine-Lucy/
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::OpenSearch::Engine::Lucy, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Search::OpenSearch::Engine::Lucy
CPAN shell
perl -MCPAN -e shell install Search::OpenSearch::Engine::Lucy
For more information on module installation, please visit the detailed CPAN module installation guide.