CosmosClient class

  • Referência
Pacote:
@azure/cosmos

Fornece uma representação lógica do lado do cliente da conta de base de dados do Azure Cosmos DB. Este cliente é utilizado para configurar e executar pedidos no serviço de base de dados do Azure Cosmos DB.

Exemplo

Instanciar um cliente e criar uma nova base 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 Ligação personalizada

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

Construtores

CosmosClient(CosmosClientOptions)

Cria um novo objeto CosmosClient . Veja CosmosClientOptions para obter mais detalhes sobre as opções que pode utilizar.
CosmosClient(string)

Cria um novo objeto CosmosClient a partir de um cadeia de ligação. A base de dados cadeia de ligação pode ser encontrada no Portal do Azure

Propriedades

databases

Utilizado para criar novas bases de dados ou consultar/ler todas as bases de dados.

Utilize .database(id) para ler, substituir ou eliminar uma base de dados existente específica por ID.

Exemplo

Criar uma nova base de dados

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

Utilizado para consultar & ler todas as ofertas.

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

Métodos

database(string)

Utilizado para ler, atualizar ou eliminar uma base de dados existente por ID ou aceder a contentores pertencentes a essa base de dados.

Isto não faz uma chamada de rede. Utilize .read para obter informações sobre a base de dados depois de obter o objeto Base de Dados .

Exemplo

Criar um novo contentor a partir de uma base de dados existente

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

Exemplo

Eliminar uma base de dados existente

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

Limpa o atualizador de pontos finais em segundo plano. Utilize client.dispose() ao destruir o CosmosClient noutro processo.
getDatabaseAccount(RequestOptions)

Obtenha informações sobre a DatabaseAccount atual (incluindo as regiões suportadas, etc.)
getReadEndpoint()

Obtém o ponto final de leitura atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.
getReadEndpoints()

Obtém o ponto final de leitura atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.
getWriteEndpoint()

Obtém o URL de ponto final de escrita atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.
getWriteEndpoints()

Obtém os pontos finais de escrita conhecidos. Útil para fins de resolução de problemas.

Os urls podem conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.
offer(string)

Utilizado para ler ou atualizar uma oferta existente por ID.

Detalhes do Construtor

CosmosClient(CosmosClientOptions)

Cria um novo objeto CosmosClient . Veja CosmosClientOptions para obter mais detalhes sobre as opções que pode utilizar.

new CosmosClient(options: CosmosClientOptions)

Parâmetros

options
CosmosClientOptions

saco de opções; exigir que, pelo menos, o ponto final e a autenticação sejam configurados

CosmosClient(string)

Cria um novo objeto CosmosClient a partir de um cadeia de ligação. A base de dados cadeia de ligação pode ser encontrada no Portal do Azure

new CosmosClient(connectionString: string)

Parâmetros

connectionString

string

Detalhes de Propriedade

databases

Utilizado para criar novas bases de dados ou consultar/ler todas as bases de dados.

Utilize .database(id) para ler, substituir ou eliminar uma base de dados existente específica 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

Utilizado para consultar & ler todas as ofertas.

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

offers: Offers

Valor de Propriedade

Offers

Detalhes de Método

database(string)

Utilizado para ler, atualizar ou eliminar uma base de dados existente por ID ou aceder a contentores pertencentes a essa base de dados.

Isto não faz uma chamada de rede. Utilize .read para obter informações sobre a base de dados depois de obter o objeto Base de Dados .

Exemplo

Criar um novo contentor a partir de uma base de dados existente

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

Exemplo

Eliminar uma base de dados existente

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

function database(id: string): Database

Parâmetros

id

string

O ID da base de dados.

Devoluções

Database

dispose()

Limpa o atualizador de pontos finais em segundo plano. Utilize client.dispose() ao destruir o CosmosClient noutro processo.

function dispose()

getDatabaseAccount(RequestOptions)

Obtenha informações sobre a DatabaseAccount atual (incluindo as regiões suportadas, etc.)

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

Parâmetros

options
RequestOptions

Devoluções

Promise<ResourceResponse<DatabaseAccount>>

getReadEndpoint()

Obtém o ponto final de leitura atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.

function getReadEndpoint(): Promise<string>

Devoluções

Promise<string>

getReadEndpoints()

Obtém o ponto final de leitura atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.

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

Devoluções

Promise<readonly string[]>

getWriteEndpoint()

Obtém o URL de ponto final de escrita atualmente utilizado. Útil para fins de resolução de problemas.

O URL pode conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.

function getWriteEndpoint(): Promise<string>

Devoluções

Promise<string>

getWriteEndpoints()

Obtém os pontos finais de escrita conhecidos. Útil para fins de resolução de problemas.

Os urls podem conter um sufixo de região (por exemplo, "-eastus") se estivermos a utilizar pontos finais específicos da localização.

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

Devoluções

Promise<readonly string[]>

offer(string)

Utilizado 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