Nick Wellnhofer > Lucy > Lucy::Index::PolyReader

Download:
Lucy-0.6.0.4.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.006000004   Source  

NAME ^

Lucy::Index::PolyReader - Multi-segment implementation of IndexReader.

SYNOPSIS ^

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

DESCRIPTION ^

PolyReader conflates index data from multiple segments. For instance, if an index contains three segments with 10 documents each, PolyReader’s doc_max() method will return 30.

Some of PolyReader’s DataReader components may be less efficient or complete than the single-segment implementations accessed via SegReader.

METHODS ^

doc_max

    my $int = $poly_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 = $poly_reader->doc_count();

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

del_count

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

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

offsets

    my $i32_array = $poly_reader->offsets();

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

seg_readers

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

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

INHERITANCE ^

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

syntax highlighting: