27 Feb 2018 08:40:23 UTC
- Distribution: Lucy
- Module version: 0.006002
- Source (raw)
- Pod Source (raw)
- Browse (raw)
- How to Contribute
- Clone repository
- Testers (1193 / 3 / 7)
- KwaliteeBus factor: 2
- License: apache_2_0
- Perl: v5.8.3
- Activity24 month
- Download (1.12MB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest version++ed by:6 non-PAUSE usersNWELLNHOF Nick Wellnhoferand 1 contributors
- The Apache Lucy Project <dev at lucy dot apache dot org>
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.
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.
folder - A Folder.
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.
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.