CosmosClient class

Pacote:

@azure/cosmos

Fornece uma representação lógica do lado do cliente da conta de banco de dados do Azure Cosmos DB. Esse cliente é usado para configurar e executar solicitações no serviço de banco de dados do Azure Cosmos DB.

Exemplo

Criar uma instância de um cliente e criar um novo banco de dados

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

Exemplo

Criar uma instância de um cliente com política de conexão personalizada

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

Construtores

CosmosClient(CosmosClientOptions)	Cria um novo objeto CosmosClient . Consulte CosmosClientOptions para obter mais detalhes sobre quais opções você pode usar.
CosmosClient(string)	Cria um novo objeto CosmosClient de um cadeia de conexão. Seu banco de dados cadeia de conexão pode ser encontrado no Portal do Azure

Propriedades

databases	Usado para criar novos bancos de dados ou consultar/ler todos os bancos de dados. Use .database(id) para ler, substituir ou excluir um banco de dados existente específico por ID. Exemplo Criar um novo banco de dados const {resource: databaseDefinition, database} = await client.databases.create({id: "<name here>"});
offers	Usado para consultar & ler todas as ofertas. Use .offer(id) para ler ou substituir ofertas existentes.

Métodos

database(string)	Usado para ler, atualizar ou excluir um banco de dados existente por ID ou acessar contêineres pertencentes a esse banco de dados. Isso não faz uma chamada de rede. Use .read para obter informações sobre o banco de dados depois de obter o objeto Database . Exemplo Criar um novo contêiner de um banco de dados existente const container = client.database("<database id>").containers.create("<container id>"); Exemplo Excluir um banco de dados existente await client.database("<id here>").delete();
dispose()	Limpa o atualizador de ponto de extremidade em segundo plano. Use client.dispose() ao destruir o CosmosClient em outro processo.
getDatabaseAccount(RequestOptions)	Obter informações sobre a DatabaseAccount atual (incluindo quais regiões têm suporte etc.)
getReadEndpoint()	Obtém o ponto de extremidade de leitura usado no momento. Útil para fins de solução de problemas. A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.
getReadEndpoints()	Obtém o ponto de extremidade de leitura usado no momento. Útil para fins de solução de problemas. A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.
getWriteEndpoint()	Obtém a URL de ponto de extremidade de gravação usada no momento. Útil para fins de solução de problemas. A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.
getWriteEndpoints()	Obtém os pontos de extremidade de gravação conhecidos. Útil para fins de solução de problemas. As URLs poderão conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.
offer(string)	Usado para ler ou atualizar uma oferta existente por ID.

Detalhes do construtor

CosmosClient(CosmosClientOptions)

Cria um novo objeto CosmosClient . Consulte CosmosClientOptions para obter mais detalhes sobre quais opções você pode usar.

new CosmosClient(options: CosmosClientOptions)

Parâmetros

options

CosmosClientOptions

recipiente de opções; exigir que pelo menos o ponto de extremidade e a autenticação sejam configurados

CosmosClient(string)

Cria um novo objeto CosmosClient de um cadeia de conexão. Seu banco de dados cadeia de conexão pode ser encontrado no Portal do Azure

new CosmosClient(connectionString: string)

Parâmetros

connectionString

string

Detalhes da propriedade

databases

Usado para criar novos bancos de dados ou consultar/ler todos os bancos de dados.

Use .database(id) para ler, substituir ou excluir um banco de dados existente específico por ID.

Exemplo

Criar um novo banco de dados

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

databases: Databases

Valor da propriedade

Databases

offers

Usado para consultar & ler todas as ofertas.

Use .offer(id) para ler ou substituir ofertas existentes.

offers: Offers

Valor da propriedade

Offers

Detalhes do método

database(string)

Usado para ler, atualizar ou excluir um banco de dados existente por ID ou acessar contêineres pertencentes a esse banco de dados.

Isso não faz uma chamada de rede. Use .read para obter informações sobre o banco de dados depois de obter o objeto Database .

Exemplo

Criar um novo contêiner de um banco de dados existente

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

Exemplo

Excluir um banco de dados existente

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

function database(id: string): Database

Parâmetros

id

string

A ID do banco de dados.

Retornos

Database

dispose()

Limpa o atualizador de ponto de extremidade em segundo plano. Use client.dispose() ao destruir o CosmosClient em outro processo.

function dispose()

getDatabaseAccount(RequestOptions)

Obter informações sobre a DatabaseAccount atual (incluindo quais regiões têm suporte etc.)

function getDatabaseAccount(options?: RequestOptions): Promise<ResourceResponse<DatabaseAccount>>

Parâmetros

options

RequestOptions

Retornos

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Obtém o ponto de extremidade de leitura usado no momento. Útil para fins de solução de problemas.

A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.

function getReadEndpoint(): Promise<string>

Retornos

Promise<string>

getReadEndpoints()

Obtém o ponto de extremidade de leitura usado no momento. Útil para fins de solução de problemas.

A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.

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

Retornos

Promise<readonly string[]>

getWriteEndpoint()

Obtém a URL de ponto de extremidade de gravação usada no momento. Útil para fins de solução de problemas.

A URL poderá conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.

function getWriteEndpoint(): Promise<string>

Retornos

Promise<string>

getWriteEndpoints()

Obtém os pontos de extremidade de gravação conhecidos. Útil para fins de solução de problemas.

As URLs poderão conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.

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

Retornos

Promise<readonly string[]>

offer(string)

Usado para ler ou atualizar uma oferta existente por ID.

function offer(id: string): Offer

Parâmetros

id

string

A ID da oferta.

Retornos

Offer