Interface ICosmosDatabase

A structural subset of the SDK Database.

Since

0.2.0

interface ICosmosDatabase {
container(id: string): ICosmosContainer;
read(): Promise<CosmosItemResponse<Record<string, unknown>>>;
}

Index

Methods

Methods

container

container(id: string): ICosmosContainer
Addresses a container by id. The container is not created.
Parameters
- id: string
  The container id
Returns ICosmosContainer
The container handle
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:362

read

read(): Promise<CosmosItemResponse<Record<string, unknown>>>
Reads the database, proving the credentials and the database name.

Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The read envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:369