Class LuceneIndexOptions

Namespace

Examine.Lucene

Assembly

Examine.Lucene.dll

Represents options for a lucene index

public class LuceneIndexOptions : IndexOptions

Inheritance

object

IndexOptions

LuceneIndexOptions

Derived

LuceneDirectoryIndexOptions

Inherited Members

IndexOptions.FieldDefinitions

IndexOptions.Validator

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Analyzer

The analyzer used in the index

public Analyzer? Analyzer { get; set; }

Property Value

Analyzer

FacetsConfig

Records per-dimension configuration. By default a dimension is flat, single valued and does not require count for the dimension; use the setters in this class to change these settings for each dim.

public FacetsConfig FacetsConfig { get; set; }

Property Value

FacetsConfig

IndexDeletionPolicy

THe index deletion policy

public IndexDeletionPolicy? IndexDeletionPolicy { get; set; }

Property Value

IndexDeletionPolicy

IndexValueTypesFactory

Specifies the index value types to use for this indexer, if this is not specified then the result of GetDefaultValueTypes(ILoggerFactory, Analyzer) will be used. This is generally used to initialize any custom value types for your indexer since the value type collection cannot be modified at runtime.

public IReadOnlyDictionary<string, IFieldValueTypeFactory>? IndexValueTypesFactory { get; set; }

Property Value

IReadOnlyDictionary<string, IFieldValueTypeFactory>

NrtCacheMaxCachedMB

Gets or sets the maximum cached size in megabytes for the Near Real-Time (NRT) cache. This defines the upper limit of memory usage for cached data in the NRT cache.

public double NrtCacheMaxCachedMB { get; set; }

Property Value

double

NrtCacheMaxMergeSizeMB

Gets or sets the maximum merge size in megabytes for the Near Real-Time (NRT) cache. This defines the upper limit of memory usage for merging operations in the NRT cache.

public double NrtCacheMaxMergeSizeMB { get; set; }

Property Value

double

NrtEnabled

Gets or sets whether Near Real-Time (NRT) indexing is enabled.

public bool NrtEnabled { get; set; }

Property Value

bool

NrtTargetMaxStaleSec

Gets or sets the maximum stale seconds for Near Real-Time (NRT) indexing. This defines the upper limit of staleness for NRT indexing operations.

public double NrtTargetMaxStaleSec { get; set; }

Property Value

double

NrtTargetMinStaleSec

Gets or sets the minimum stale seconds for Near Real-Time (NRT) indexing. This defines the lower limit of staleness for NRT indexing operations.

public double NrtTargetMinStaleSec { get; set; }

Property Value

double

UseTaxonomyIndex

Gets or sets whether a sidecar taxonomy index should be used for faceting. When set to false, faceting will use SortedSetDocValues instead of a separate taxonomy index. Default is true for backwards compatibility.

public bool UseTaxonomyIndex { get; set; }

Property Value

bool