 |
Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
|
Lucene.Net
3.0.3
Lucene.Net is a .NET port of the Java Lucene Indexing Library
|
A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold and later release a single "snapshot" of an index. While the snapshot is held, the IndexWriter will not remove any files associated with it even if the index is otherwise being actively, arbitrarily changed. Because we wrap another arbitrary IndexDeletionPolicy, this gives you the freedom to continue using whatever IndexDeletionPolicy you would normally want to use with your index. Note that you can re-use a single instance of SnapshotDeletionPolicy across multiple writers as long as they are against the same index Directory. Any snapshot held when a writer is closed will "survive" when the next writer is opened. More...
Inherits Lucene.Net.Index.IndexDeletionPolicy.
Public Member Functions | |
| SnapshotDeletionPolicy (IndexDeletionPolicy primary) | |
| virtual void | OnInit< T > (IList< T > commits) |
| This is called once when a writer is first instantiated to give the policy a chance to remove old commit points. | |
| virtual void | OnCommit< T > (IList< T > commits) |
| | |
| virtual IndexCommit | Snapshot () |
| Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot. | |
| virtual void | Release () |
| Release the currently held snapshot. | |
A IndexDeletionPolicy that wraps around any other IndexDeletionPolicy and adds the ability to hold and later release a single "snapshot" of an index. While the snapshot is held, the IndexWriter will not remove any files associated with it even if the index is otherwise being actively, arbitrarily changed. Because we wrap another arbitrary IndexDeletionPolicy, this gives you the freedom to continue using whatever IndexDeletionPolicy you would normally want to use with your index. Note that you can re-use a single instance of SnapshotDeletionPolicy across multiple writers as long as they are against the same index Directory. Any snapshot held when a writer is closed will "survive" when the next writer is opened.
WARNING: This API is a new and experimental and may suddenly change.
Definition at line 44 of file SnapshotDeletionPolicy.cs.
| Lucene.Net.Index.SnapshotDeletionPolicy.SnapshotDeletionPolicy | ( | IndexDeletionPolicy | primary | ) |
Definition at line 51 of file SnapshotDeletionPolicy.cs.
|
virtual |
This is called each time the writer completed a commit. This gives the policy a chance to remove old commit points with each commit.
The policy may now choose to delete old commit points by calling method IndexCommit.Delete() of IndexCommit.
This method is only called when IndexWriter.Commit() or IndexWriter.Close() is called, or possibly not at all if the IndexWriter.Rollback() is called.
<u>Note:</u> the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.
| commits | List of IndexCommit, sorted by age (the 0th one is the oldest commit). |
Implements Lucene.Net.Index.IndexDeletionPolicy.
| T | : | IndexCommit |
Definition at line 65 of file SnapshotDeletionPolicy.cs.
|
virtual |
This is called once when a writer is first instantiated to give the policy a chance to remove old commit points.
The writer locates all index commits present in the index directory and calls this method. The policy may choose to delete some of the commit points, doing so by calling method IndexCommit.Delete() of IndexCommit.
<u>Note:</u> the last CommitPoint is the most recent one, i.e. the "front index state". Be careful not to delete it, unless you know for sure what you are doing, and unless you can afford to lose the index content while doing that.
| commits | List of current point-in-time commits, sorted by age (the 0th one is the oldest commit). |
Implements Lucene.Net.Index.IndexDeletionPolicy.
| T | : | IndexCommit |
Definition at line 56 of file SnapshotDeletionPolicy.cs.
|
virtual |
Release the currently held snapshot.
Definition at line 102 of file SnapshotDeletionPolicy.cs.
|
virtual |
Take a snapshot of the most recent commit to the index. You must call release() to free this snapshot. Note that while the snapshot is held, the files it references will not be deleted, which will consume additional disk space in your index. If you take a snapshot at a particularly bad time (say just before you call optimize()) then in the worst case this could consume an extra 1X of your total index size, until you release the snapshot.
Definition at line 84 of file SnapshotDeletionPolicy.cs.
1.8.3
