Class BinaryDocValuesField

Field that stores a per-document BytesRef value.

The values are stored directly with no sharing, which is a good fit when the fields don't share (many) values, such as a title field. If values may be shared and sorted it's better to use SortedDocValuesField. Here's an example usage:

  document.Add(new BinaryDocValuesField(name, new BytesRef("hello")));

If you also need to store the value, you should add a separate StoredField instance.

Inheritance
System.Object
Field
BinaryDocValuesField
DerefBytesDocValuesField
StraightBytesDocValuesField
Implements
System.IFormattable
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)
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public class BinaryDocValuesField : Field, IIndexableField, IFormattable

Constructors

| Improve this Doc View Source

BinaryDocValuesField(String, BytesRef)

Create a new binary DocValues field.

Declaration
public BinaryDocValuesField(string name, BytesRef value)
Parameters
Type Name Description
System.String name

field name

BytesRef value

binary content

Exceptions
Type Condition
System.ArgumentNullException

if the field name is null.

Fields

| Improve this Doc View Source

TYPE

Type for straight bytes DocValues.

Declaration
public static readonly FieldType TYPE
Field Value
Type Description
FieldType

Implements

System.IFormattable

Extension Methods

See Also