Scroll to navigation

Lucy::Search::PolySearcher(3pm) User Contributed Perl Documentation Lucy::Search::PolySearcher(3pm)

NAME

Lucy::Search::PolySearcher - Aggregate results from multiple Searchers.

SYNOPSIS

    my $schema = MySchema->new;
    for my $index (@index_paths) {
        push @searchers, Lucy::Search::IndexSearcher->new( index => $index );
    }
    my $poly_searcher = Lucy::Search::PolySearcher->new(
        schema    => $schema,
        searchers => \@searchers,
    );
    my $hits = $poly_searcher->hits( query => $query );

DESCRIPTION

The primary use for PolySearcher is to aggregate results from several indexes on a single machine.

CONSTRUCTORS

new( [labeled params] )

    my $poly_searcher = Lucy::Search::PolySearcher->new(
        schema    => $schema,
        searchers => \@searchers,
    );
  • schema - A Schema.
  • searchers - An array of Searchers.

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.

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.

INHERITANCE

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

2017-08-02 perl v5.26.0