Interface ICosmosContainer

A structural subset of the SDK Container — the members the adapter drives.

Since

0.2.0

interface ICosmosContainer {
    items: ICosmosItems;
    item(id: string, partitionKey?: CosmosPartitionKeyValue): ICosmosItem;
    read(): Promise<CosmosItemResponse<CosmosContainerDefinition>>;
}

Index

Properties

Methods

Properties

`Readonly`items

items: ICosmosItems

The document collection.

Methods

item

item(id: string, partitionKey?: CosmosPartitionKeyValue): ICosmosItem
Addresses one document by id and partition key.
Parameters
- id: string
  The document id
- OptionalpartitionKey: CosmosPartitionKeyValue
  The partition-key value
Returns ICosmosItem
The item handle
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:339

read

read(): Promise<CosmosItemResponse<CosmosContainerDefinition>>
Reads the container definition, which is also what proves the container exists.

Returns Promise<CosmosItemResponse<CosmosContainerDefinition>>
The definition envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:347