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

Instanciar 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

Instanciar um cliente com uma 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 a partir de uma cadeia de conexão. Sua cadeia de conexão de banco de dados pode ser encontrada 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 específico existente por id. Exemplo Criar uma nova base 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 fora 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 a atualização do ponto de extremidade em segundo plano. Use client.dispose() ao destruir o CosmosClient dentro de outro processo.
getDatabaseAccount(RequestOptions)	Obtenha informações sobre o DatabaseAccount atual do (incluindo quais regiões são suportadas, etc.)
getReadEndpoint()	Obtém o ponto de extremidade de leitura usado atualmente. Útil para fins de solução de problemas. O url pode 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 atualmente. Útil para fins de solução de problemas. O url pode conter um sufixo de região (por exemplo, "-eastus") se estivermos usando pontos de extremidade específicos do local.
getWriteEndpoint()	Obtém a URL do ponto de extremidade de gravação usada atualmente. Útil para fins de solução de problemas. O url pode 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 podem 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

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

CosmosClient(string)

Cria um novo objeto CosmosClient a partir de uma cadeia de conexão. Sua cadeia de conexão de banco de dados pode ser encontrada no Portal do Azure

new CosmosClient(connectionString: string)

Parâmetros

connectionString

string

Detalhes de 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 específico existente por id.

Exemplo

Criar uma nova base de dados

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

databases: Databases

Valor de Propriedade

Databases

offers

Usado para consultar & ler todas as ofertas.

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

offers: Offers

Valor de Propriedade

Offers

Detalhes de 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 fora 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

O id do banco de dados.

Devoluções

Database

dispose()

Limpa a atualização do ponto de extremidade em segundo plano. Use client.dispose() ao destruir o CosmosClient dentro de outro processo.

function dispose()

getDatabaseAccount(RequestOptions)

Obtenha informações sobre o DatabaseAccount atual do (incluindo quais regiões são suportadas, etc.)

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

Parâmetros

options

RequestOptions

Devoluções

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

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

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

function getReadEndpoint(): Promise<string>

Devoluções

Promise<string>

getReadEndpoints()

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

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

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

Devoluções

Promise<readonly string[]>

getWriteEndpoint()

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

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

function getWriteEndpoint(): Promise<string>

Devoluções

Promise<string>

getWriteEndpoints()

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

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

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

Devoluções

Promise<readonly string[]>

offer(string)

Usado para ler ou atualizar uma oferta existente por id.

function offer(id: string): Offer

Parâmetros

id

string

O id da oferta.

Devoluções

Offer