Index.Hash Method

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

Overloads

Hash(DataType)	Returns an instance of the HashIndex class with specified DataType for the Azure Cosmos DB service.
Hash(DataType, Int16)	Returns an instance of the HashIndex class with specified DataType and precision for the Azure Cosmos DB service.

Hash(DataType)

Returns an instance of the HashIndex class with specified DataType for the Azure Cosmos DB service.

public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType);

static member Hash : Microsoft.Azure.Documents.DataType -> Microsoft.Azure.Documents.HashIndex

Public Shared Function Hash (dataType As DataType) As HashIndex

Parameters

dataType

DataType

Specifies the target data type for the index path specification.

Returns

HashIndex

An instance of HashIndex type.

Examples

Here is an example to create HashIndex instance passing in the DataType:

HashIndex hashIndex = Index.Hash(DataType.String);

See also

• DataType

Hash(DataType, Int16)

Returns an instance of the HashIndex class with specified DataType and precision for the Azure Cosmos DB service.

public static Microsoft.Azure.Documents.HashIndex Hash (Microsoft.Azure.Documents.DataType dataType, short precision);

static member Hash : Microsoft.Azure.Documents.DataType * int16 -> Microsoft.Azure.Documents.HashIndex

Public Shared Function Hash (dataType As DataType, precision As Short) As HashIndex

Parameters

dataType

DataType

Specifies the target data type for the index path specification.

precision

Int16

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

Returns

HashIndex

An instance of HashIndex type.

Examples

Here is an example to create HashIndex instance passing in the DataType and precision:

HashIndex hashIndex = Index.Hash(DataType.String, 3);

See also

• DataType