Class DiskDocValuesFormat

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Inheritance

object

DocValuesFormat

DiskDocValuesFormat

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.ReferenceEquals(object, object)

Namespace: Lucene.Net.Codecs.DiskDV

Assembly: Lucene.Net.Codecs.dll

Syntax

[DocValuesFormatName("Disk")]
public sealed class DiskDocValuesFormat : DocValuesFormat

Constructors

DiskDocValuesFormat()

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Declaration

public DiskDocValuesFormat()

Fields

DATA_CODEC

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Declaration

public static readonly string DATA_CODEC

Field Value

Type	Description
string

DATA_EXTENSION

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Declaration

public static readonly string DATA_EXTENSION

Field Value

Type	Description
string

META_CODEC

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Declaration

public static readonly string META_CODEC

Field Value

Type	Description
string

META_EXTENSION

DocValues format that keeps most things on disk. Only things like disk offsets are loaded into ram.

Note

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

Declaration

public static readonly string META_EXTENSION

Field Value

Type	Description
string

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)