IndexingPolicy Class

Cosmos DB indexing policy.

Inheritance

azure.mgmt.cosmosdb._serialization.Model

IndexingPolicy

Constructor

IndexingPolicy(*, automatic: bool | None = None, indexing_mode: str | _models.IndexingMode = 'consistent', included_paths: List[_models.IncludedPath] | None = None, excluded_paths: List[_models.ExcludedPath] | None = None, composite_indexes: List[List[_models.CompositePath]] | None = None, spatial_indexes: List[_models.SpatialSpec] | None = None, vector_indexes: List[_models.VectorIndex] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name	Description
automatic	bool Indicates if the indexing policy is automatic.
indexing_mode	str or IndexingMode Indicates the indexing mode. Known values are: "consistent", "lazy", and "none". Default value: consistent
included_paths	list[IncludedPath] List of paths to include in the indexing.
excluded_paths	list[ExcludedPath] List of paths to exclude from indexing.
composite_indexes	list[list[CompositePath]] List of composite path list.
spatial_indexes	list[SpatialSpec] List of spatial specifics.
vector_indexes	list[VectorIndex] List of paths to include in the vector indexing.

Variables

Name	Description
automatic	bool Indicates if the indexing policy is automatic.
indexing_mode	str or IndexingMode Indicates the indexing mode. Known values are: "consistent", "lazy", and "none".
included_paths	list[IncludedPath] List of paths to include in the indexing.
excluded_paths	list[ExcludedPath] List of paths to exclude from indexing.
composite_indexes	list[list[CompositePath]] List of composite path list.
spatial_indexes	list[SpatialSpec] List of spatial specifics.
vector_indexes	list[VectorIndex] List of paths to include in the vector indexing.