IndexingPolicy interface

Package:

@azure/cosmos

Properties

automatic
compositeIndexes	An array of <xref:CompositeIndexes> representing composite indexes to be included.
excludedPaths	An array of <xref:IncludedPath> represents the paths to be excluded for indexing.
includedPaths	An array of <xref:IncludedPath> represents the paths to be included for indexing.
indexingMode	The indexing mode (consistent or lazy) IndexingMode.
spatialIndexes
vectorIndexes	An array of VectorIndex represents the vector index paths to be included for indexing.

Property Details

automatic

automatic?: boolean

Property Value

boolean

compositeIndexes

An array of <xref:CompositeIndexes> representing composite indexes to be included.

compositeIndexes?: CompositePath[][]

Property Value

CompositePath[][]

excludedPaths

An array of <xref:IncludedPath> represents the paths to be excluded for indexing.

excludedPaths?: IndexedPath[]

Property Value

IndexedPath[]

includedPaths

An array of <xref:IncludedPath> represents the paths to be included for indexing.

includedPaths?: IndexedPath[]

Property Value

IndexedPath[]

indexingMode

The indexing mode (consistent or lazy) IndexingMode.

indexingMode?: "consistent" | "lazy" | "none"

Property Value

"consistent" | "lazy" | "none"

spatialIndexes

spatialIndexes?: SpatialIndex[]

Property Value

SpatialIndex[]

vectorIndexes

An array of VectorIndex represents the vector index paths to be included for indexing.

vectorIndexes?: VectorIndex[]

Property Value

VectorIndex[]