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).
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.
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.
Set the path to the file that the Snapshot object serves as a proxy for.
my $string = $snapshot->get_path();
Lucy::Index::Snapshot isa Clownfish::Obj.
Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
Apache License, Version 2.0.
Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.