29 Dec 2010 02:53:48 UTC
- Distribution: KinoSearch
- Source (raw)
- Browse (raw)
- How to Contribute
- Issues (5)
- Testers (34 / 42 / 5)
- KwaliteeBus factor: 0
- License: perl_5
- Activity24 month
- Download (850.99KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionCREAMYG Marvin Humphreyand 1 contributors
- Marvin Humphrey <marvin at rectangular dot com>
- COPYRIGHT AND LICENSE
KinoSearch::Index::Snapshot - Point-in-time index file list.
my $snapshot = KinoSearch::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 = KinoSearch::Index::Snapshot->new;
Constructor. Takes no arguments.
Return an array of all entries.
Return the number of entries (including directories).
Add a filepath to the snapshot.
Delete a filepath from the snapshot.
Returns: true if the entry existed and was successfully deleted, false otherwise.
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 object, allowing an assignment idiom.
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.
Get the path to the snapshot file. Initially undef; updated by read_file(), write_file(), and set_path().
KinoSearch::Index::Snapshot isa KinoSearch::Object::Obj.
Copyright 2005-2010 Marvin Humphrey
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.