Interface ICosmosItems

A structural subset of the SDK Items collection — the members the data source drives.

Since

0.2.0

interface ICosmosItems {
    batch(
        operations: readonly CosmosBatchOperation[],
        partitionKey: CosmosPartitionKeyValue,
    ): Promise<CosmosBatchResponse>;
    create(
        body: Record<string, unknown>,
    ): Promise<CosmosItemResponse<Record<string, unknown>>>;
    query(spec: CosmosQuerySpec): ICosmosQueryIterator<Record<string, unknown>>;
}

Index

Methods

batch create query

Methods

batch

batch(
operations: readonly CosmosBatchOperation[],
partitionKey: CosmosPartitionKeyValue,
): Promise<CosmosBatchResponse>
Runs a transactional batch, atomic within one partition-key value.
Parameters
- operations: readonly CosmosBatchOperation[]
  The operations, at most 100
- partitionKey: CosmosPartitionKeyValue
  The single partition-key value every operation targets
Returns Promise<CosmosBatchResponse>
The batch response
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:257

create

create(
body: Record<string, unknown>,
): Promise<CosmosItemResponse<Record<string, unknown>>>
Inserts one document, refusing a duplicate id within the partition.
Parameters
- body: Record<string, unknown>
  The document to insert
Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The created document envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:240

query

query(spec: CosmosQuerySpec): ICosmosQueryIterator<Record<string, unknown>>
Runs a parameterized SQL query across the container.
Parameters
- spec: CosmosQuerySpec
  The query text and its bound parameters
Returns ICosmosQueryIterator<Record<string, unknown>>
An iterator over the matching rows
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:248