NAME

       Lucy::Search::IndexSearcher - Execute searches against a single index.

SYNOPSIS

           my $searcher = Lucy::Search::IndexSearcher->new(
               index => '/path/to/index'
           );
           my $hits = $searcher->hits(
               query      => 'foo bar',
               offset     => 0,
               num_wanted => 100,
           );

DESCRIPTION

       Use the IndexSearcher class to perform search queries against an index.  (For searching
       multiple indexes at once, see PolySearcher).

       IndexSearchers operate against a single point-in-time view or Snapshot of the index.  If
       an index is modified, a new IndexSearcher must be opened to access the changes.

CONSTRUCTORS

   new( [labeled params] )
           my $searcher = Lucy::Search::IndexSearcher->new(
               index => '/path/to/index'
           );

       •   index - Either a string filepath, a Folder, or an IndexReader.

METHODS

   hits( [labeled params] )
       Return a Hits object containing the top results.

       •   query - Either a Query object or a query string.

       •   offset - The number of most-relevant hits to discard, typically used when "paging"
           through hits N at a time.  Setting "offset" to 20 and "num_wanted" to 10 retrieves
           hits 21-30, assuming that 30 hits can be found.

       •   num_wanted - The number of hits you would like to see after "offset" is taken into
           account.

       •   sort_spec - A Lucy::Search::SortSpec, which will affect how results are ranked and
           returned.

   collect( [labeled params] )
       Iterate over hits, feeding them into a Collector.

       •   query - A Query.

       •   collector - A Collector.

   doc_max()
       Return the maximum number of docs in the collection represented by the Searcher, which is
       also the highest possible internal doc id.  Documents which have been marked as deleted
       but not yet purged are included in this count.

   doc_freq( [labeled params] )
       Return the number of documents which contain the term in the given field.

       •   field - Field name.

       •   term - The term to look up.

   fetch_doc(doc_id)
       Retrieve a document.  Throws an error if the doc id is out of range.

       •   doc_id - A document id.

   get_schema()
       Accessor for the object's "schema" member.

   get_reader()
       Accessor for the object's "reader" member.

INHERITANCE

       Lucy::Search::IndexSearcher isa Lucy::Search::Searcher isa Lucy::Object::Obj.