Package version:

Class CosmosClient

Provides a client-side logical representation of the Azure Cosmos DB database account. This client is used to configure and execute requests in the Azure Cosmos DB database service.

Example: Instantiate a client and create a new database

const client = new CosmosClient({endpoint: "<URL HERE>", key: "<KEY HERE>"});
await client.databases.create({id: "<database name here>"});

Example: Instantiate a client with custom Connection Policy

const client = new CosmosClient({
   endpoint: "<URL HERE>",
   key: "<KEY HERE>",
   connectionPolicy: {
    requestTimeout: 10000,
   },
});

Constructors

constructor

Properties

databases offers

Methods

database dispose getDatabaseAccount getReadEndpoint getReadEndpoints getWriteEndpoint getWriteEndpoints offer

Constructors

constructor

Properties

Readonlydatabases

databases: Databases

Used for creating new databases, or querying/reading all databases.

Use .database(id) to read, replace, or delete a specific, existing database by id.

Example: Create a new database

const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});

Readonlyoffers

offers: Offers

Used for querying & reading all offers.

Use .offer(id) to read, or replace existing offers.

Methods

database

  • database(id): Database

  • Used for reading, updating, or deleting a existing database by id or accessing containers belonging to that database.

    This does not make a network call. Use .read to get info about the database after getting the Database object.

    Parameters

    • id: string

      The id of the database.

    Returns Database

    Example: Create a new container off of an existing database

    const container = client.database("<database id>").containers.create("<container id>");

    Example: Delete an existing database

    await client.database("<id here>").delete();

dispose

getDatabaseAccount

getReadEndpoint

  • getReadEndpoint(): Promise<string>

  • Gets the currently used read endpoint. Useful for troubleshooting purposes.

    The url may contain a region suffix (e.g. "-eastus") if we're using location specific endpoints.

    Returns Promise<string>

getReadEndpoints

  • getReadEndpoints(): Promise<readonly string[]>

  • Gets the currently used read endpoint. Useful for troubleshooting purposes.

    The url may contain a region suffix (e.g. "-eastus") if we're using location specific endpoints.

    Returns Promise<readonly string[]>

getWriteEndpoint

  • getWriteEndpoint(): Promise<string>

  • Gets the currently used write endpoint url. Useful for troubleshooting purposes.

    The url may contain a region suffix (e.g. "-eastus") if we're using location specific endpoints.

    Returns Promise<string>

getWriteEndpoints

  • getWriteEndpoints(): Promise<readonly string[]>

  • Gets the known write endpoints. Useful for troubleshooting purposes.

    The urls may contain a region suffix (e.g. "-eastus") if we're using location specific endpoints.

    Returns Promise<readonly string[]>

offer

Settings

Member Visibility