IndexingPolicy Class
Definition
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.
Represents the indexing policy configuration for a collection in the Azure Cosmos DB service.
public sealed class IndexingPolicytype IndexingPolicy = classPublic NotInheritable Class IndexingPolicy- Inheritance
-
IndexingPolicy
Remarks
Indexing policies can used to configure which properties (JSON paths) are included/excluded, whether the index is updated consistently or offline (lazy), automatic vs. opt-in per-document, as well as the precision and type of index per path.
Refer to https://docs.microsoft.com/azure/cosmos-db/index-policy for additional information on how to specify indexing policies.
Constructors
| IndexingPolicy() |
Initializes a new instance of the IndexingPolicy class for the Azure Cosmos DB service. |
Properties
| Automatic |
Gets or sets a value that indicates whether automatic indexing is enabled for a collection in the Azure Cosmos DB service. |
| CompositeIndexes |
Gets the composite indexes for additional indexes |
| ExcludedPaths |
Gets the collection containing ExcludedPath objects in the Azure Cosmos DB service. |
| IncludedPaths |
Gets the collection containing IncludedPath objects in the Azure Cosmos DB service. |
| IndexingMode |
Gets or sets the indexing mode (consistent or lazy) in the Azure Cosmos DB service. |
| SpatialIndexes |
Collection of spatial index definitions to be used |
| VectorIndexes |
Gets the vector indexes for additional indexes |
