Class MemoryDocValuesFormat

In-memory docvalues format.

Inheritance

object

DocValuesFormat

MemoryDocValuesFormat

Inherited Members

DocValuesFormat.SetDocValuesFormatFactory(IDocValuesFormatFactory)

DocValuesFormat.GetDocValuesFormatFactory()

DocValuesFormat.Name

DocValuesFormat.ToString()

DocValuesFormat.ForName(string)

DocValuesFormat.AvailableDocValuesFormats

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Lucene.Net.Codecs.Memory

Assembly: Lucene.Net.Codecs.dll

Syntax

[DocValuesFormatName("Memory")]
public class MemoryDocValuesFormat : DocValuesFormat

Constructors

MemoryDocValuesFormat()

Calls MemoryDocValuesFormat(PackedInts.DEFAULT) (MemoryDocValuesFormat(float))

Declaration

public MemoryDocValuesFormat()

MemoryDocValuesFormat(float)

Creates a new MemoryDocValuesFormat with the specified acceptableOverheadRatio for Lucene.Net.Index.NumericDocValues.

Note

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

Declaration

public MemoryDocValuesFormat(float acceptableOverheadRatio)

Parameters

Type	Name	Description
float	acceptableOverheadRatio	Compression parameter for numerics. Currently this is only used when the number of unique values is small.

Fields

MAX_BINARY_FIELD_LENGTH

Maximum length for each binary doc values field.

Declaration

public static readonly int MAX_BINARY_FIELD_LENGTH

Field Value

Type	Description
int

Methods

FieldsConsumer(SegmentWriteState)

Returns a Lucene.Net.Codecs.DocValuesConsumer to write docvalues to the index.

Declaration

public override DocValuesConsumer FieldsConsumer(SegmentWriteState state)

Parameters

Type	Name	Description
SegmentWriteState	state

Returns

Type	Description
DocValuesConsumer

Overrides

Lucene.Net.Codecs.DocValuesFormat.FieldsConsumer(Lucene.Net.Index.SegmentWriteState)

FieldsProducer(SegmentReadState)

Returns a Lucene.Net.Codecs.DocValuesProducer to read docvalues from the index.

NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.

Declaration

public override DocValuesProducer FieldsProducer(SegmentReadState state)

Parameters

Type	Name	Description
SegmentReadState	state

Returns

Type	Description
DocValuesProducer

Overrides

Lucene.Net.Codecs.DocValuesFormat.FieldsProducer(Lucene.Net.Index.SegmentReadState)