Lucy::Index::Snapshot - Point-in-time index file list.
my $snapshot = Lucy::Index::Snapshot->new; $snapshot->read_file( folder => $folder ); # load most recent snapshot my $files = $snapshot->list; print "$_\n" for @$files;
A Snapshot is list of index files and folders. Because index files, once written, are never modified, a Snapshot defines a point-in-time view of the data in an index.
IndexReader objects interpret the data associated with a single Snapshot.
my $snapshot = Lucy::Index::Snapshot->new;
Constructor. Takes no arguments.
my $arrayref = $snapshot->list();
Return an array of all entries.
my $int = $snapshot->num_entries();
Return the number of entries (including directories).
$snapshot->add_entry($entry);
Add a filepath to the snapshot.
my $bool = $snapshot->delete_entry($entry);
Delete a filepath from the snapshot.
Returns: true if the entry existed and was successfully deleted, false otherwise.
my $result = $snapshot->read_file( folder => $folder, # required path => $path, # default: undef );
Decode a snapshot file and initialize the object to reflect its contents.
folder - A Folder.
path - The location of the snapshot file. If not supplied, the most recent snapshot file in the base directory will be chosen.
Returns: the Snapshot object itself
$snapshot->write_file( folder => $folder, # required path => $path, # default: undef );
Write a snapshot file. The caller must lock the index while this operation takes place, and the operation will fail if the snapshot file already exists.
path - The path of the file to write. If undef, a file name will be chosen which supersedes the latest snapshot file in the index folder.
$snapshot->set_path($path);
Set the path to the file that the Snapshot object serves as a proxy for.
my $string = $snapshot->get_path();
Get the path to the snapshot file. Initially undef; updated by read_file(), write_file(), and set_path().
Lucy::Index::Snapshot isa Clownfish::Obj.
To install Lucy, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Lucy
CPAN shell
perl -MCPAN -e shell install Lucy
For more information on module installation, please visit the detailed CPAN module installation guide.