Databases class

  • Referência
Pacote:
@azure/cosmos

Operações para criar novos bancos de dados e ler/consultar todos os bancos de dados

Consulte Banco de dados para ler ou excluir um banco de dados existente; use client.database(id).

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 databases.readAll() antes de cada item.read() chamada, para garantir que o banco de dados exista; faça isso uma vez na inicialização do aplicativo.

Propriedades

client

Métodos

create(DatabaseRequest, RequestOptions)

Envie uma solicitação para criar um banco de dados.

Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados.

Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs do Usuário.
createIfNotExists(DatabaseRequest, RequestOptions)

Verifique se existe um banco de dados e, se não existir, crie-o. Isso fará com que uma operação de leitura com base na ID no body, se não for encontrada, uma operação de criação.

Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados.

Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs do Usuário.
query(string | SqlQuerySpec, FeedOptions)

Consulta todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); *

readAll(FeedOptions)

Lê todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

Detalhes da propriedade

client 

client: CosmosClient

Valor da propriedade

CosmosClient

Detalhes do método

create(DatabaseRequest, RequestOptions)

Envie uma solicitação para criar um banco de dados.

Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados.

Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs do Usuário.

function create(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parâmetros

body
DatabaseRequest

O DatabaseDefinition que representa o Banco de Dados a ser criado.

options
RequestOptions

Use para definir opções como tamanho da página de resposta, tokens de continuação etc.

Retornos

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

Verifique se existe um banco de dados e, se não existir, crie-o. Isso fará com que uma operação de leitura com base na ID no body, se não for encontrada, uma operação de criação.

Um banco de dados gerencia usuários, permissões e um conjunto de contêineres. Cada conta de banco de dados do Azure Cosmos DB é capaz de dar suporte a vários bancos de dados nomeados independentes, sendo o banco de dados o contêiner lógico para dados.

Cada Banco de Dados consiste em um ou mais contêineres, cada um dos quais, por sua vez, contém um ou mais documentos. Como os bancos de dados são um recurso administrativo, a Chave Mestra de Serviço será necessária para acessar e concluir com êxito qualquer ação usando as APIs do Usuário.

function createIfNotExists(body: DatabaseRequest, options?: RequestOptions): Promise<DatabaseResponse>

Parâmetros

body
DatabaseRequest

O DatabaseDefinition que representa o Banco de Dados a ser criado.

options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Consulta todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); * 

function query(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<any>

Parâmetros

query

string | SqlQuerySpec

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Use para definir opções como tamanho da página de resposta, tokens de continuação etc.

Retornos

QueryIterator<any>

QueryIterator Permite que você retorne todos os bancos de dados em uma matriz ou itere sobre eles um de cada vez. *

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const querySpec: SqlQuerySpec = { * query: "SELECT * FROM root r WHERE r.id = @db", * parameters: [ * {name: "@db", value: "Todo"} * ] * }; * const {body: databaseList} = await client.databases.query(querySpec).fetchAll(); * 

function query<T>(query: string | SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

Parâmetros

query

string | SqlQuerySpec

Configuração de consulta para a operação. Consulte SqlQuerySpec para obter mais informações sobre como configurar uma consulta.

options
FeedOptions

Use para definir opções como tamanho da página de resposta, tokens de continuação etc.

Retornos

QueryIterator<T>

QueryIterator Permite que você retorne todos os bancos de dados em uma matriz ou itere sobre eles um de cada vez. *

readAll(FeedOptions)

Lê todos os bancos de dados.

Exemplo

Leia todos os bancos de dados na matriz. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); * 

function readAll(options?: FeedOptions): QueryIterator<DatabaseDefinition & Resource>

Parâmetros

options
FeedOptions

Use para definir opções como tamanho da página de resposta, tokens de continuação etc.

Retornos

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Permite que você retorne todos os bancos de dados em uma matriz ou itere sobre eles um de cada vez. *