Index Class

Reference

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Base class for IndexingPolicy Indexes in the Azure Cosmos DB service, you should use a concrete Index like HashIndex or RangeIndex.

[Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.IndexJsonConverter))]
public abstract class Index : Microsoft.Azure.Documents.JsonSerializable

[<Newtonsoft.Json.JsonConverter(typeof(Microsoft.Azure.Documents.IndexJsonConverter))>]
type Index = class
    inherit JsonSerializable

Public MustInherit Class Index
Inherits JsonSerializable

Inheritance: Object

JsonSerializable
Index

Derived: Microsoft.Azure.Documents.HashIndex

Microsoft.Azure.Documents.RangeIndex

Microsoft.Azure.Documents.SpatialIndex

Attributes: Newtonsoft.Json.JsonConverterAttribute

Constructors

Index(IndexKind)

Initializes a new instance of the Index class for the Azure Cosmos DB service.

Properties

Kind	Gets or sets the kind of indexing to be applied in the Azure Cosmos DB service.

Methods

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.
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)
Range(DataType)	Returns an instance of the RangeIndex class with specified DataType for the Azure Cosmos DB service.
Range(DataType, Int16)	Returns an instance of the RangeIndex class with specified DataType and precision for the Azure Cosmos DB service.
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)
Spatial(DataType)	Returns an instance of the SpatialIndex class with specified DataType for the Azure Cosmos DB service.
ToString()	Returns the string representation of the object in the Azure Cosmos DB service. (Inherited from JsonSerializable)

Applies to