1Lucy::Index::DocReader(U3spemr)Contributed Perl DocumentLautciyo:n:Index::DocReader(3pm)
2
3
4

NAME

6       Lucy::Index::DocReader - Retrieve stored documents.
7

SYNOPSIS

9           my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
10           my $doc        = $doc_reader->fetch_doc($doc_id);
11

DESCRIPTION

13       DocReader defines the interface by which documents (with all stored
14       fields) are retrieved from the index.  The default implementation
15       returns HitDoc objects.
16

ABSTRACT METHODS

18   fetch_doc
19           my $hit_doc = $doc_reader->fetch_doc($doc_id);
20
21       Retrieve the document identified by "doc_id".
22
23       Returns: a HitDoc.
24

METHODS

26   aggregator
27           my $result = $doc_reader->aggregator(
28               readers => $readers,  # required
29               offsets => $offsets,  # required
30           );
31
32       Returns a DocReader which divvies up requests to its sub-readers
33       according to the offset range.
34
35       •   readers - An array of DocReaders.
36
37       •   offsets - Doc id start offsets for each reader.
38

INHERITANCE

40       Lucy::Index::DocReader isa Lucy::Index::DataReader isa Clownfish::Obj.
41
42
43
44perl v5.38.0                      2023-07-20       Lucy::Index::DocReader(3pm)
Impressum