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.
fullTextIndexes	An array of FullTextIndex representing full text indexes to be included.
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

TypeScript

automatic?: boolean

Property Value

boolean

compositeIndexes

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

TypeScript

compositeIndexes?: CompositePath[][]

Property Value

CompositePath[][]

excludedPaths

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

TypeScript

excludedPaths?: IndexedPath[]

Property Value

IndexedPath[]

fullTextIndexes

An array of FullTextIndex representing full text indexes to be included.

TypeScript

fullTextIndexes?: FullTextIndex[]

Property Value

FullTextIndex[]

includedPaths

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

TypeScript

includedPaths?: IndexedPath[]

Property Value

IndexedPath[]

indexingMode

The indexing mode (consistent or lazy) IndexingMode.

TypeScript

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

Property Value

"consistent" | "lazy" | "none"

spatialIndexes

TypeScript

spatialIndexes?: SpatialIndex[]

Property Value

SpatialIndex[]

vectorIndexes

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

TypeScript

vectorIndexes?: VectorIndex[]

Property Value

VectorIndex[]