HashIndex Class

Definition

Namespace:

Microsoft.Azure.Documents

Assemblies:

Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:

Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

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

public sealed class HashIndex : Microsoft.Azure.Documents.Index

type HashIndex = class
    inherit Index

Public NotInheritable Class HashIndex
Inherits Index

Inheritance

Object

JsonSerializable

Index

HashIndex

Implements

ICloneable

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.
HashIndex(DataType, Int16)	Initializes a new instance of the HashIndex class with specified DataType and precision for the Azure Cosmos DB service.

Properties

DataType	Gets or sets the data type for which this index should be applied in the Azure Cosmos DB service.
Kind	Gets or sets the kind of indexing to be applied in the Azure Cosmos DB service. (Inherited from Index)
Precision	Gets or sets the precision for this particular index in the Azure Cosmos DB service.

Methods

Clone()	Creates a copy of the hash index for the Azure Cosmos DB service.
LoadFrom(JsonReader)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
LoadFrom(JsonReader, JsonSerializerSettings)	Loads the object from the specified JSON reader in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
SaveTo(Stream, SerializationFormattingPolicy, JsonSerializerSettings)	Saves the object to the specified stream in the Azure Cosmos DB service. (Inherited from JsonSerializable)
ToString()	Returns the string representation of the object in the Azure Cosmos DB service. (Inherited from JsonSerializable)