Class HashIndex

Namespace

Microsoft.Azure.Documents

Assembly

Microsoft.Azure.Documents.Client.dll

Represents details of the hash index setting in an Azure Cosmos DB service.

public sealed class HashIndex : Index, ICloneable

Inheritance

object

JsonSerializable

Index

HashIndex

Implements

ICloneable

Inherited Members

Index.Range(DataType)

Index.Range(DataType, short)

Index.Hash(DataType)

Index.Hash(DataType, short)

Index.Spatial(DataType)

Index.Kind

JsonSerializable.SaveTo(Stream, SerializationFormattingPolicy)

JsonSerializable.SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)

JsonSerializable.LoadFrom(JsonReader)

JsonSerializable.LoadFrom(JsonReader, JsonSerializerSettings)

JsonSerializable.LoadFrom<T>(Stream)

JsonSerializable.LoadFromWithConstructor<T>(Stream, Func<T>)

JsonSerializable.LoadFromWithConstructor<T>(Stream, Func<T>, JsonSerializerSettings)

JsonSerializable.ToString()

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

TypeCheckFunctionsExtensions.IsArray(object)

TypeCheckFunctionsExtensions.IsBool(object)

TypeCheckFunctionsExtensions.IsDefined(object)

TypeCheckFunctionsExtensions.IsNull(object)

TypeCheckFunctionsExtensions.IsNumber(object)

TypeCheckFunctionsExtensions.IsObject(object)

TypeCheckFunctionsExtensions.IsPrimitive(object)

TypeCheckFunctionsExtensions.IsString(object)

Remarks

Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop = 5.

Constructors

HashIndex(DataType)

Initializes a new instance of the HashIndex class with specified DataType for the Azure Cosmos DB service.

public HashIndex(DataType dataType)

Parameters

dataType DataType

Specifies the target data type for the index path specification.

Examples

Here is an example to instantiate HashIndex class passing in the DataType:

HashIndex hashIndex = new HashIndex(DataType.String);

See Also

DataType

HashIndex(DataType, short)

Initializes a new instance of the HashIndex class with specified DataType and precision for the Azure Cosmos DB service.

public HashIndex(DataType dataType, short precision)

Parameters

dataType DataType

Specifies the target data type for the index path specification.

precision short

Specifies the precision to be used for the data type associated with this index.

Examples

Here is an example to instantiate HashIndex class passing in the DataType and precision:

HashIndex hashIndex = new HashIndex(DataType.String, 3);

See Also

DataType

Properties

DataType

Gets or sets the data type for which this index should be applied in the Azure Cosmos DB service.

public DataType DataType { get; set; }

Property Value

DataType

The data type for which this index should be applied.

Remarks

Refer to Customizing the indexing policy of a collection for valid ranges of values.

Precision

Gets or sets the precision for this particular index in the Azure Cosmos DB service.

public short? Precision { get; set; }

Property Value

short?

The precision for this particular index. Returns null, if not set.

Remarks

Refer to Customizing the indexing policy of a collection for valid ranges of values.

Methods

Clone()

Creates a copy of the hash index for the Azure Cosmos DB service.

public object Clone()

Returns

object

A clone of the hash index.