ContainerDefinition interface

Package:

@azure/cosmos

Properties

changeFeedPolicy	Change feed policy related to the container
computedProperties	The computed properties of the container
conflictResolutionPolicy	The conflict resolution policy used to resolve conflicts in a container.
defaultTtl	The default time to live in seconds for items in a container.
fullTextPolicy	The full text policy information for storing items in a container.
geospatialConfig	Geospatial configuration for a collection. Type is set to Geography by default
id	The id of the container.
indexingPolicy	The indexing policy associated with the container.
partitionKey	The partition key for the container.
uniqueKeyPolicy	Policy for additional keys that must be unique per partition key
vectorEmbeddingPolicy	The vector embedding policy information for storing items in a container.

Property Details

changeFeedPolicy

Change feed policy related to the container

changeFeedPolicy?: ChangeFeedPolicy

Property Value

ChangeFeedPolicy

computedProperties

The computed properties of the container

computedProperties?: ComputedProperty[]

Property Value

ComputedProperty[]

conflictResolutionPolicy

The conflict resolution policy used to resolve conflicts in a container.

conflictResolutionPolicy?: ConflictResolutionPolicy

Property Value

ConflictResolutionPolicy

defaultTtl

The default time to live in seconds for items in a container.

defaultTtl?: number

Property Value

number

fullTextPolicy

The full text policy information for storing items in a container.

fullTextPolicy?: FullTextPolicy

Property Value

FullTextPolicy

geospatialConfig

Geospatial configuration for a collection. Type is set to Geography by default

geospatialConfig?: { type: GeospatialType }

Property Value

{ type: GeospatialType }

id

The id of the container.

id?: string

Property Value

string

indexingPolicy

The indexing policy associated with the container.

indexingPolicy?: IndexingPolicy

Property Value

IndexingPolicy

partitionKey

The partition key for the container.

partitionKey?: PartitionKeyDefinition

Property Value

PartitionKeyDefinition

uniqueKeyPolicy

Policy for additional keys that must be unique per partition key

uniqueKeyPolicy?: UniqueKeyPolicy

Property Value

UniqueKeyPolicy

vectorEmbeddingPolicy

The vector embedding policy information for storing items in a container.

vectorEmbeddingPolicy?: VectorEmbeddingPolicy

Property Value

VectorEmbeddingPolicy