Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Databases

Operations for creating new databases, and reading/querying all databases

see

Database for reading or deleting an existing database; use client.database(id).

Note: all these operations make calls against a fixed budget. You should design your system such that these calls scale sublinearly with your application. For instance, do not call databases.readAll() before every single item.read() call, to ensure the database exists; do this once on application start up.

Hierarchy

  • Databases

Index

Properties

Methods

Properties

client

client: CosmosClient

The parent CosmosClient for the Database.

Methods

create

  • Send a request for creating a database.

    A database manages users, permissions and a set of containers. Each Azure Cosmos DB Database Account is able to support multiple independent named databases, with the database being the logical container for data.

    Each Database consists of one or more containers, each of which in turn contain one or more documents. Since databases are an administrative resource, the Service Master Key will be required in order to access and successfully complete any action using the User APIs.

    Parameters

    Returns Promise<DatabaseResponse>

createIfNotExists

  • Check if a database exists, and if it doesn't, create it. This will make a read operation based on the id in the body, then if it is not found, a create operation.

    A database manages users, permissions and a set of containers. Each Azure Cosmos DB Database Account is able to support multiple independent named databases, with the database being the logical container for data.

    Each Database consists of one or more containers, each of which in turn contain one or more documents. Since databases are an an administrative resource, the Service Master Key will be required in order to access and successfully complete any action using the User APIs.

    Parameters

    Returns Promise<DatabaseResponse>

query

  • Queries all databases.

    example

    Read all databases to array.

    const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @db",
  parameters: [
    {name: "@db", value: "Todo"}
  ]
};
const {body: databaseList} = await client.databases.query(querySpec).toArray();

    Parameters

    • query: string | SqlQuerySpec

      Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.

    • Optional options: FeedOptions

      Use to set options like response page size, continuation tokens, etc.

    Returns QueryIterator<any>

    Allows you to return all databases in an array or iterate over them one at a time.

  • Queries all databases.

    example

    Read all databases to array.

    const querySpec: SqlQuerySpec = {
  query: "SELECT * FROM root r WHERE r.id = @db",
  parameters: [
    {name: "@db", value: "Todo"}
  ]
};
const {body: databaseList} = await client.databases.query(querySpec).toArray();

    Type parameters

    • T

    Parameters

    • query: string | SqlQuerySpec

      Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.

    • Optional options: FeedOptions

      Use to set options like response page size, continuation tokens, etc.

    Returns QueryIterator<T>

    Allows you to return all databases in an array or iterate over them one at a time.

readAll

  • Reads all databases.

    example

    Read all databases to array.

    const {body: databaseList} = await client.databases.readAll().toArray();

    Parameters

    • Optional options: FeedOptions

      Use to set options like response page size, continuation tokens, etc.

    Returns QueryIterator<DatabaseDefinition & Resource>

    Allows you to return all databases in an array or iterate over them one at a time.

Generated using TypeDoc