Class NoDeletionPolicy

An IndexDeletionPolicy which keeps all index commits around, never deleting them. This class is a singleton and can be accessed by referencing INSTANCE.

Inheritance
object
IndexDeletionPolicy
NoDeletionPolicy
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public sealed class NoDeletionPolicy : IndexDeletionPolicy

Fields

INSTANCE

The single instance of this class.

Declaration
public static readonly IndexDeletionPolicy INSTANCE
Field Value
Type Description
IndexDeletionPolicy

Methods

Clone()

An IndexDeletionPolicy which keeps all index commits around, never deleting them. This class is a singleton and can be accessed by referencing INSTANCE.

Declaration
public override object Clone()
Returns
Type Description
object
Overrides

OnCommit<T>(IList<T>)

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 Delete() of IndexCommit.

This method is only called when Commit()} or Dispose() is called, or possibly not at all if the Rollback()} method is called.

Note: 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.

Declaration
public override void OnCommit<T>(IList<T> commits) where T : IndexCommit
Parameters
Type Name Description
IList<T> commits

List of IndexCommits, sorted by age (the 0th one is the oldest commit).
Type Parameters
Name Description
T
Overrides

OnInit<T>(IList<T>)

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 Delete().

Note: 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.

Declaration
public override void OnInit<T>(IList<T> commits) where T : IndexCommit
Parameters
Type Name Description
IList<T> commits

List of current point-in-time commits (IndexCommit), sorted by age (the 0th one is the oldest commit). Note that for a new index this method is invoked with an empty list.
Type Parameters
Name Description
T
Overrides