Class TrackingIndexWriter

Class that tracks changes to a delegated IndexWriter, used by ControlledRealTimeReopenThread<T> to ensure specific changes are visible. Create this class (passing your IndexWriter), and then pass this class to ControlledRealTimeReopenThread<T>. Be sure to make all changes via the TrackingIndexWriter, otherwise ControlledRealTimeReopenThread<T> won't know about the changes.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance
System.Object
TrackingIndexWriter
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public class TrackingIndexWriter

Constructors

| Improve this Doc View Source

TrackingIndexWriter(IndexWriter)

Create a TrackingIndexWriter wrapping the provided IndexWriter.

Declaration
public TrackingIndexWriter(IndexWriter writer)
Parameters
Type Name Description
IndexWriter writer

Properties

| Improve this Doc View Source

Generation

Return the current generation being indexed.

Declaration
public virtual long Generation { get; }
Property Value
Type Description
System.Int64
| Improve this Doc View Source

IndexWriter

Return the wrapped IndexWriter.

Declaration
public virtual IndexWriter IndexWriter { get; }
Property Value
Type Description
IndexWriter

Methods

| Improve this Doc View Source

AddDocument(IEnumerable<IIndexableField>)

Calls AddDocument(IEnumerable<IIndexableField>) and returns the generation that reflects this change.

Declaration
public virtual long AddDocument(IEnumerable<IIndexableField> d)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IIndexableField> d
Returns
Type Description
System.Int64
| Improve this Doc View Source

AddDocument(IEnumerable<IIndexableField>, Analyzer)

Calls AddDocument(IEnumerable<IIndexableField>, Analyzer) and returns the generation that reflects this change.

Declaration
public virtual long AddDocument(IEnumerable<IIndexableField> d, Analyzer a)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IIndexableField> d
Analyzer a
Returns
Type Description
System.Int64
| Improve this Doc View Source

AddDocuments(IEnumerable<IEnumerable<IIndexableField>>)

Calls AddDocuments(IEnumerable<IEnumerable<IIndexableField>>) and returns the generation that reflects this change.

Declaration
public virtual long AddDocuments(IEnumerable<IEnumerable<IIndexableField>> docs)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<IIndexableField>> docs
Returns
Type Description
System.Int64
| Improve this Doc View Source

AddDocuments(IEnumerable<IEnumerable<IIndexableField>>, Analyzer)

Calls AddDocuments(IEnumerable<IEnumerable<IIndexableField>>, Analyzer) and returns the generation that reflects this change.

Declaration
public virtual long AddDocuments(IEnumerable<IEnumerable<IIndexableField>> docs, Analyzer a)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<IIndexableField>> docs
Analyzer a
Returns
Type Description
System.Int64
| Improve this Doc View Source

AddIndexes(IndexReader[])

Calls AddIndexes(IndexReader[]) and returns the generation that reflects this change.

Declaration
public virtual long AddIndexes(params IndexReader[] readers)
Parameters
Type Name Description
IndexReader[] readers
Returns
Type Description
System.Int64
| Improve this Doc View Source

AddIndexes(Directory[])

Calls AddIndexes(Directory[]) and returns the generation that reflects this change.

Declaration
public virtual long AddIndexes(params Directory[] dirs)
Parameters
Type Name Description
Directory[] dirs
Returns
Type Description
System.Int64
| Improve this Doc View Source

DeleteAll()

Calls DeleteAll() and returns the generation that reflects this change.

Declaration
public virtual long DeleteAll()
Returns
Type Description
System.Int64
| Improve this Doc View Source

DeleteDocuments(Term)

Calls DeleteDocuments(Term) and returns the generation that reflects this change.

Declaration
public virtual long DeleteDocuments(Term t)
Parameters
Type Name Description
Term t
Returns
Type Description
System.Int64
| Improve this Doc View Source

DeleteDocuments(Term[])

Calls DeleteDocuments(Term[]) and returns the generation that reflects this change.

Declaration
public virtual long DeleteDocuments(params Term[] terms)
Parameters
Type Name Description
Term[] terms
Returns
Type Description
System.Int64
| Improve this Doc View Source

DeleteDocuments(Query)

Calls DeleteDocuments(Query) and returns the generation that reflects this change.

Declaration
public virtual long DeleteDocuments(Query q)
Parameters
Type Name Description
Query q
Returns
Type Description
System.Int64
| Improve this Doc View Source

DeleteDocuments(Query[])

Calls DeleteDocuments(Query[]) and returns the generation that reflects this change.

Declaration
public virtual long DeleteDocuments(params Query[] queries)
Parameters
Type Name Description
Query[] queries
Returns
Type Description
System.Int64
| Improve this Doc View Source

GetAndIncrementGeneration()

Return and increment current gen.

Note

This API is for internal purposes only and might change in incompatible ways in the next release.

Declaration
public virtual long GetAndIncrementGeneration()
Returns
Type Description
System.Int64
| Improve this Doc View Source

TryDeleteDocument(IndexReader, Int32)

Cals TryDeleteDocument(IndexReader, Int32) and returns the generation that reflects this change.

Declaration
public virtual long TryDeleteDocument(IndexReader reader, int docID)
Parameters
Type Name Description
IndexReader reader
System.Int32 docID
Returns
Type Description
System.Int64
| Improve this Doc View Source

UpdateDocument(Term, IEnumerable<IIndexableField>)

Calls UpdateDocument(Term, IEnumerable<IIndexableField>) and returns the generation that reflects this change.

Declaration
public virtual long UpdateDocument(Term t, IEnumerable<IIndexableField> d)
Parameters
Type Name Description
Term t
System.Collections.Generic.IEnumerable<IIndexableField> d
Returns
Type Description
System.Int64
| Improve this Doc View Source

UpdateDocument(Term, IEnumerable<IIndexableField>, Analyzer)

Calls UpdateDocument(Term, IEnumerable<IIndexableField>, Analyzer) and returns the generation that reflects this change.

Declaration
public virtual long UpdateDocument(Term t, IEnumerable<IIndexableField> d, Analyzer a)
Parameters
Type Name Description
Term t
System.Collections.Generic.IEnumerable<IIndexableField> d
Analyzer a
Returns
Type Description
System.Int64
| Improve this Doc View Source

UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>)

Calls UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>) and returns the generation that reflects this change.

Declaration
public virtual long UpdateDocuments(Term t, IEnumerable<IEnumerable<IIndexableField>> docs)
Parameters
Type Name Description
Term t
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<IIndexableField>> docs
Returns
Type Description
System.Int64
| Improve this Doc View Source

UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>, Analyzer)

Calls UpdateDocuments(Term, IEnumerable<IEnumerable<IIndexableField>>, Analyzer) and returns the generation that reflects this change.

Declaration
public virtual long UpdateDocuments(Term t, IEnumerable<IEnumerable<IIndexableField>> docs, Analyzer a)
Parameters
Type Name Description
Term t
System.Collections.Generic.IEnumerable<System.Collections.Generic.IEnumerable<IIndexableField>> docs
Analyzer a
Returns
Type Description
System.Int64