Database class

  • Referência
Pacote:
@azure/cosmos

Operações para ler ou eliminar uma base de dados existente.

Veja Databases para criar novas bases de dados e ler/consultar todas as bases de dados; utilize client.databases.

Nota: todas estas operações fazem chamadas relativamente a um orçamento fixo. Deve estruturar o seu sistema de modo a que estas chamadas dimensionem sublinearmente com a sua aplicação. Por exemplo, não chame database.read() antes de cada item.read() chamada, para garantir que a base de dados existe; faça-o uma vez no arranque da aplicação.

Construtores

Database(CosmosClient, string, ClientContext)

Devolve uma nova Database instância. Nota: a intenção é obter este objeto através client.database(id)de CosmosClient , não instanciar o mesmo.

Propriedades

client
containers

Utilizado para criar novos contentores ou consultar/ler todos os contentores. Utilize .database(id) para ler, substituir ou eliminar um ID específico existente Database .

Exemplo

Criar um novo contentor

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

Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões.
users

Utilizado para criar novos utilizadores ou consultar/ler todos os utilizadores. Utilize .user(id) para ler, substituir ou eliminar um ID específico existente User .

Métodos

container(string)

Utilizado para ler, substituir ou eliminar um ID específico existente Database . Utilize .containers a criação de novos contentores ou a consulta/leitura de todos os contentores.

Exemplo

Eliminar um contentor

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

Elimine a Base de Dados especificada.
read(RequestOptions)

Leia a definição da Base de Dados especificada.
readOffer(RequestOptions)

Obtém oferta na base de dados. Se não existir nenhuma, devolve uma OfferResponse com undefined.
user(string)

Utilizado para ler, substituir ou eliminar um ID específico existente User . Utilize .users para criar novos utilizadores ou consultar/ler todos os utilizadores.

Detalhes do Construtor

Database(CosmosClient, string, ClientContext)

Devolve uma nova Database instância. Nota: a intenção é obter este objeto através client.database(id)de CosmosClient , não instanciar o 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

Utilizado para criar novos contentores ou consultar/ler todos os contentores. Utilize .database(id) para ler, substituir ou eliminar um ID específico existente Database .

Exemplo

Criar um novo contentor

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

Devolve um URL de referência ao recurso. Utilizado para ligar em Permissões.

string url

Valor de Propriedade

string

users

Utilizado para criar novos utilizadores ou consultar/ler todos os utilizadores. Utilize .user(id) para ler, substituir ou eliminar um ID específico existente User .

users: Users

Valor de Propriedade

Users

Detalhes de Método

container(string)

Utilizado para ler, substituir ou eliminar um ID específico existente Database . Utilize .containers a criação de novos contentores ou a consulta/leitura de todos os contentores.

Exemplo

Eliminar um contentor

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

function container(id: string): Container

Parâmetros

id

string

Devoluções

Container

delete(RequestOptions)

Elimine a Base de Dados especificada.

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

Parâmetros

options
RequestOptions

Devoluções

Promise<DatabaseResponse>

read(RequestOptions)

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

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

Parâmetros

options
RequestOptions

Devoluções

Promise<DatabaseResponse>

readOffer(RequestOptions)

Obtém oferta na base de dados. Se não existir nenhuma, devolve uma OfferResponse com undefined.

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

Parâmetros

options
RequestOptions

Devoluções

Promise<OfferResponse>

user(string)

Utilizado para ler, substituir ou eliminar um ID específico existente User . Utilize .users para criar novos utilizadores ou consultar/ler todos os utilizadores.

function user(id: string): User

Parâmetros

id

string

Devoluções

User