NAME
SYNOPSIS
DESCRIPTION
CONSTRUCTOR
- open
METHODS
- lexicon
- posting_list
- max_docs
- num_docs
- fetch_doc
INHERITANCE
COPYRIGHT
LICENSE, DISCLAIMER, BUGS, etc.

NAME

KinoSearch::Index::IndexReader - Read from an inverted index.

SYNOPSIS

    my $reader = KinoSearch::Index::IndexReader->open(
        invindex => MySchema->read('/path/to/invindex'),
    );

DESCRIPTION

IndexReader is the interface through which Searchers access the content of an InvIndex.

IndexReader objects always represent a point-in-time view of an invindex as it existed at the moment the reader was created. If you want search results to reflect modifications to an InvIndex, you must create a new IndexReader after the update process completes.

When a IndexReader is created, a small portion of the InvIndex is loaded into memory; additional sort caches are filled as relevant queries arrive. For large document collections, the warmup time may become noticable, in which case reusing the reader is likely to speed up your search application.

Caching an IndexReader (or a Searcher which contains an IndexReader) is especially helpful when running a high-activity app in a persistent environment, as under mod_perl or FastCGI.

CONSTRUCTOR

open( [labeled params] )

    my $reader = KinoSearch::Index::IndexReader->open(
        invindex     => MySchema->read('/path/to/invindex'),
        lock_factory => $lock_factory,
    );

IndexReader is an abstract base class; open() functions like a constructor, but actually returns one of two possible subclasses: SegReader, which reads a single segment, and MultiReader, which channels the output of several SegReaders. Since each segment is a self-contained inverted index, a SegReader is in effect a complete index reader.

invindex - A KinoSearch::InvIndex.
lock_factory - A KinoSearch::Store::LockFactory. Read-locking is off by default; supplying this argument turns it on.