1Lucy::Index::PostingLisUtsReeradCeorn(t3r)ibuted Perl DoLcuucmye:n:tIantdieoxn::PostingListReader(3)
2
3
4

NAME

6       Lucy::Index::PostingListReader - Read postings data.
7

SYNOPSIS

9           my $posting_list_reader
10               = $seg_reader->obtain("Lucy::Index::PostingListReader");
11           my $posting_list = $posting_list_reader->posting_list(
12               field => 'title',
13               term  => 'foo',
14           );
15

DESCRIPTION

17       PostingListReaders produce PostingList objects which convey document
18       matching information.
19

ABSTRACT METHODS

21   posting_list
22           my $posting_list = $posting_list_reader->posting_list(
23               field => $field,  # default: undef
24               term  => $term,   # default: undef
25           );
26
27       Returns a PostingList, or undef if either "field" is undef or "field"
28       is not present in any documents.
29
30field - A field name.
31
32term - If supplied, the PostingList will be pre-located to this
33           term using seek().
34

METHODS

36   aggregator
37           my $result = $posting_list_reader->aggregator(
38               readers => $readers,  # required
39               offsets => $offsets,  # required
40           );
41
42       Returns undef since PostingLists may only be iterated at the segment
43       level.
44

INHERITANCE

46       Lucy::Index::PostingListReader isa Lucy::Index::DataReader isa
47       Clownfish::Obj.
48
49
50
51perl v5.36.0                      2023-01-20 Lucy::Index::PostingListReader(3)
Impressum