NAME

Lucy::Index::SegReader - Single-segment IndexReader.

SYNOPSIS

my $polyreader = Lucy::Index::IndexReader->open(
    index => '/path/to/index',
);
my $seg_readers = $polyreader->seg_readers;
for my $seg_reader (@$seg_readers) {
    my $seg_name = $seg_reader->get_seg_name;
    my $num_docs = $seg_reader->doc_max;
    print "Segment $seg_name ($num_docs documents):\n";
    my $doc_reader = $seg_reader->obtain("Lucy::Index::DocReader");
    for my $doc_id ( 1 .. $num_docs ) {
        my $doc = $doc_reader->fetch_doc($doc_id);
        print "  $doc_id: $doc->{title}\n";
    }
}

DESCRIPTION

SegReader interprets the data within a single segment of an index.

Generally speaking, only advanced users writing subclasses which manipulate data at the segment level need to deal with the SegReader API directly.

Nearly all of SegReader’s functionality is implemented by pluggable components spawned by Architecture’s factory methods.

METHODS

get_seg_name

my $string = $seg_reader->get_seg_name();

Return the name of the segment.

get_seg_num

my $int = $seg_reader->get_seg_num();

Return the number of the segment.

del_count

my $int = $seg_reader->del_count();

Return the number of documents which have been marked as deleted but not yet purged from the index.

doc_max

my $int = $seg_reader->doc_max();

Return the maximum number of documents available to the reader, which is also the highest possible internal document id. Documents which have been marked as deleted but not yet purged from the index are included in this count.

doc_count

my $int = $seg_reader->doc_count();

Return the number of documents available to the reader, subtracting any that are marked as deleted.

_offsets

my $i32_array = $seg_reader->_offsets();

Return an array with one entry for each segment, corresponding to segment doc_id start offset.

seg_readers

my $arrayref = $seg_reader->seg_readers();

Return an array of all the SegReaders represented within the IndexReader.

INHERITANCE

Lucy::Index::SegReader isa Lucy::Index::IndexReader isa Lucy::Index::DataReader isa Clownfish::Obj.