Share via

IndexingPolicy interface

Package:
@azure/arm-cosmosdb

Cosmos DB indexing policy

Properties

automatic

Indicates if the indexing policy is automatic
compositeIndexes

List of composite path list
excludedPaths

List of paths to exclude from indexing
fullTextIndexes

List of paths to include in the full text indexing
includedPaths

List of paths to include in the indexing
indexingMode

Indicates the indexing mode.
spatialIndexes

List of spatial specifics
vectorIndexes

List of paths to include in the vector indexing

Property Details

automatic

Indicates if the indexing policy is automatic

automatic?: boolean

Property Value

boolean

compositeIndexes

List of composite path list

compositeIndexes?: CompositePath[][]

Property Value

CompositePath[][]

excludedPaths

List of paths to exclude from indexing

excludedPaths?: ExcludedPath[]

Property Value

ExcludedPath[]

fullTextIndexes

List of paths to include in the full text indexing

fullTextIndexes?: FullTextIndexPath[]

Property Value

FullTextIndexPath[]

includedPaths

List of paths to include in the indexing

includedPaths?: IncludedPath[]

Property Value

IncludedPath[]

indexingMode

Indicates the indexing mode.

indexingMode?: string

Property Value

string

spatialIndexes

List of spatial specifics

spatialIndexes?: SpatialSpec[]

Property Value

SpatialSpec[]

vectorIndexes

List of paths to include in the vector indexing

vectorIndexes?: VectorIndex[]

Property Value

VectorIndex[]