Database class

  • Referência
Pacote:
@azure/cosmos

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

Consulte Databases 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 contra um orçamento fixo. Você deve projetar seu sistema de modo que essas chamadas sejam dimensionadas de forma sublinear com seu aplicativo. Por exemplo, não chame database.read() antes de cada item.read() chamada, 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 de Database. Observação: a intenção é obter esse objeto por meio client.database(id)de CosmosClient , 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 um específico existente Database 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 vinculação 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 específico existente User por ID.

Métodos

container(string)

Usado para ler, substituir ou excluir um específico existente Database por ID. Use .containers a criação de novos contêineres ou a consulta/leitura de 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 a oferta no banco de dados. Se nenhum existir, retornará um OfferResponse com indefinido.
user(string)

Usado para ler, substituir ou excluir um específico existente User 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 de Database. Observação: a intenção é obter esse objeto por meio client.database(id)de CosmosClient , 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 um específico existente Database 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 vinculação 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 específico existente User por ID.

users: Users

Valor da propriedade

Users

Detalhes do método

container(string)

Usado para ler, substituir ou excluir um específico existente Database por ID. Use .containers a criação de novos contêineres ou a consulta/leitura de 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 a 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 específico existente User 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