Database class

Pacote:

@azure/cosmos

Operações para ler ou excluir um banco de dados existente.

Consulte Bancos de Dados para criar novos bancos de dados e ler/consultar todos os bancos de dados; use client.databases.

Observação: todas essas operações fazem chamadas em relação a um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas sublinearmente com seu aplicativo. Por exemplo, não chame database.read() antes de cada chamada item.read(), para garantir que o banco de dados exista; faça isso uma vez na inicialização do aplicativo.

Construtores

Database(CosmosClient, string, ClientContext)

Retorna uma nova instância do banco de dados . Observação: a intenção é obter esse objeto de cosmosClient por meio de client.database(id), não instanciá-lo por conta própria.

Propriedades

client
containers	Usado para criar novos contêineres ou consultar/ler todos os contêineres. Use .database(id) para ler, substituir ou excluir uma de Banco de Dados específica por ID. exemplo Criar um novo contêiner const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});
id
url	Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.
users	Usado para criar novos usuários ou consultar/ler todos os usuários. Use .user(id) para ler, substituir ou excluir um de usuário existente específico por ID.

Métodos

container(string)	Usado para ler, substituir ou excluir um banco de dados existente específico por ID. Use .containers criar novos contêineres ou consultar/ler todos os contêineres. exemplo Excluir um contêiner await client.database("<db id>").container("<container id>").delete();
delete(RequestOptions)	Exclua o banco de dados especificado.
read(RequestOptions)	Leia a definição do banco de dados especificado.
readOffer(RequestOptions)	Obtém oferta no banco de dados. Se nenhum existir, retornará um OfferResponse com indefinido.
user(string)	Usado para ler, substituir ou excluir um usuário existente específico por ID. Use .users para criar novos usuários ou consultar/ler todos os usuários.

Detalhes do construtor

Database(CosmosClient, string, ClientContext)

Retorna uma nova instância do banco de dados .

Observação: a intenção é obter esse objeto de cosmosClient por meio de client.database(id), não instanciá-lo por conta própria.

new Database(client: CosmosClient, id: string, clientContext: ClientContext)

Parâmetros

client

CosmosClient

id

string

clientContext

ClientContext

Detalhes da propriedade

client

client: CosmosClient

Valor da propriedade

CosmosClient

containers

Usado para criar novos contêineres ou consultar/ler todos os contêineres.

Use .database(id) para ler, substituir ou excluir uma de Banco de Dados específica por ID.

exemplo

Criar um novo contêiner

const {body: containerDefinition, container} = await client.database("<db id>").containers.create({id: "<container id>"});

containers: Containers

Valor da propriedade

Containers

id

id: string

Valor da propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vincular em Permissões.

string url

Valor da propriedade

string

users

Usado para criar novos usuários ou consultar/ler todos os usuários.

Use .user(id) para ler, substituir ou excluir um de usuário existente específico por ID.

users: Users

Valor da propriedade

Users

Detalhes do método

container(string)

Usado para ler, substituir ou excluir um banco de dados existente específico por ID.

Use .containers criar novos contêineres ou consultar/ler todos os contêineres.

exemplo

Excluir um contêiner

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

function container(id: string): Container

Parâmetros

id

string

Retornos

Container

delete(RequestOptions)

Exclua o banco de dados especificado.

function delete(options?: RequestOptions): Promise<DatabaseResponse>

Parâmetros

options

RequestOptions

Retornos

Promise<DatabaseResponse>

read(RequestOptions)

Leia a definição do banco de dados especificado.

function read(options?: RequestOptions): Promise<DatabaseResponse>

Parâmetros

options

RequestOptions

Retornos

Promise<DatabaseResponse>

readOffer(RequestOptions)

Obtém oferta no banco de dados. Se nenhum existir, retornará um OfferResponse com indefinido.

function readOffer(options?: RequestOptions): Promise<OfferResponse>

Parâmetros

options

RequestOptions

Retornos

Promise<OfferResponse>

user(string)

Usado para ler, substituir ou excluir um usuário existente específico por ID.

Use .users para criar novos usuários ou consultar/ler todos os usuários.

function user(id: string): User

Parâmetros

id

string

Retornos

User