IndexOptions Class

Namespace: Hazelcast.Models

Assembly: Hazelcast.Net.dll

Configuration of an index.

public class IndexOptions : IIdentifiedDataSerializable

Inheritance

object

IndexOptions

Implements

IIdentifiedDataSerializable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Remarks

Hazelcast support three types of indexes: sorted, hash and bitmap indexes. They can be created on one or more attributes, specified by their name.

Sorted indexes can be used with equality and range predicates and have logarithmic search time.

Hash indexes can be used with equality predicates and have constant search time assuming the hash function of the indexed field disperses the elements properly.

Bitmap indexes (to be completed).

Constructors

Name	Description
IndexOptions()	Initializes a new instance of the IndexOptions class.
IndexOptions(IndexOptions)	Initializes a new instance of the IndexOptions class.
IndexOptions(IEnumerable<string>)	Initializes a new instance of the IndexOptions class.

Fields

Name	Description
DefaultType

Properties

Name	Description
Attributes	Gets the indexed attributes.
BTreeIndex	Gets or sets the btree index options.
BitmapIndex	Gets or sets the bitmap index options.
BitmapIndexOptions	Gets or sets the bitmap index options.
ClassId	Gets the identifier of the class.
FactoryId	Gets the identifier of the IDataSerializableFactory that can create instances of the class.
Name	Gets or sets the name of the index.
Type	Gets or sets the type of the index.

Methods

Name	Description
AddAttribute(string)	Adds an indexed attribute.
AddAttributes(params string[])	Adds indexed attributes.
ReadData(IObjectDataInput)	Deserializes the object by reading from an IObjectDataInput.
ToString()	Returns a string that represents the current object.
WriteData(IObjectDataOutput)	Serializes the object by writing to an IObjectDataOutput.