IndexingMode Class

Specifies the supported indexing modes.

Inheritance

builtins.object

IndexingMode

Constructor

IndexingMode()

Attributes

Consistent

Index is updated synchronously with a create or update operation. With consistent indexing, query behavior is the same as the default consistency level for the collection. The index is always kept up to date with the data.

Consistent: Literal['consistent'] = 'consistent'

Lazy

Index is updated asynchronously with respect to a create or update operation. Not supported for new containers since June/2020. With lazy indexing, queries are eventually consistent. The index is updated when the collection is idle.

Lazy: Literal['lazy'] = 'lazy'

NoIndex

No index is provided. Setting IndexingMode to "None" drops the index. Use this if you don't want to maintain the index for a document collection, to save the storage cost or improve the write throughput. Your queries will degenerate to scans of the entire collection.

NoIndex: Literal['none'] = 'none'