Database class

Pacote:

@azure/cosmos

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

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

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

Construtores

Database(CosmosClient, string, ClientContext)

Retorna uma nova instância Banco de Dados. Nota: a intenção é obter este objeto de CosmosClient via client.database(id), não instanciá-lo você mesmo.

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

Métodos

container(string)	Usado para ler, substituir ou excluir um banco de dados específico e existente 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 fornecido.
read(RequestOptions)	Leia a definição da Base de Dados dada.
readOffer(RequestOptions)	Obtém oferta no banco de dados. Se não existir, retorna um OfferResponse com undefined.
user(string)	Usado para ler, substituir ou excluir um de usuário específico e existente 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 Banco de Dados.

Nota: a intenção é obter este objeto de CosmosClient via client.database(id), não instanciá-lo você mesmo.

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

Parâmetros

client

CosmosClient

id

string

clientContext

ClientContext

Detalhes de Propriedade

client

client: CosmosClient

Valor de 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 banco de dados de específico e existente 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 de Propriedade

Containers

id

id: string

Valor de Propriedade

string

url

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

string url

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

users: Users

Valor de Propriedade

Users

Detalhes de Método

container(string)

Usado para ler, substituir ou excluir um banco de dados específico e existente 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

Devoluções

Container

delete(RequestOptions)

Exclua o banco de dados fornecido.

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

Parâmetros

options

RequestOptions

Devoluções

Promise<DatabaseResponse>

read(RequestOptions)

Leia a definição da Base de Dados dada.

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

Parâmetros

options

RequestOptions

Devoluções

Promise<DatabaseResponse>

readOffer(RequestOptions)

Obtém oferta no banco de dados. Se não existir, retorna um OfferResponse com undefined.

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

Parâmetros

options

RequestOptions

Devoluções

Promise<OfferResponse>

user(string)

Usado para ler, substituir ou excluir um de usuário específico e existente 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

Devoluções

User