NAME

KinoSearch::Index::Snapshot - Point-in-time index file list.

SYNOPSIS

    my $snapshot = KinoSearch::Index::Snapshot->new;
    $snapshot->read_file( folder => $folder );    # load most recent snapshot
    my $files = $snapshot->list;
    print "$_\n" for @$files;

DESCRIPTION

A Snapshot is list of index files. Because index files, once written, are never modified, the list of files in a Snapshot defines a point-in-time view of the data in an index.

IndexReader objects interpret the data associated with a single Snapshot.

CONSTRUCTORS

new()

    my $snapshot = KinoSearch::Index::Snapshot->new;

Constructor. Takes no arguments.

METHODS

list()

Return a list of all entries.

num_entries()

Return the number of entries (including directories).

add_entry(entry)

Add a filepath to the snapshot.

delete_entry(entry)

Delete a filepath from the snapshot.

Returns: true if the entry existed and was successfully deleted, false otherwise.

read_file( [labeled params] )

Decode a snapshot file and initialize the object to reflect its contents.

folder - A Folder.
filename - The name of the snapshot file. If not supplied, the most recent snapshot file will be chosen.

Returns: the object, allowing an assignment idiom.

write_file( [labeled params] )

Write a snapshot file. The caller must lock the index while this operation takes place, and the operation will fail if the file already exists.

folder - A Folder.
filename - The name of the file to write to. If undef, a name will be chosen which supersedes the latest snapshot file in the index folder.

get_filename()

The name of the file that the Snapshot serves as a proxy for. Initially undef; updated by read_file() and write_file().

CPAN RT