Databases class

Pacote:

@azure/cosmos

Operações para criar novas bases de dados e leitura/consulta de todas as bases de dados

Veja Base de dados para ler ou eliminar uma base de dados existente; utilize client.database(id).

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 databases.readAll() antes de cada item.read() chamada, para garantir que a base de dados existe; faça-o uma vez no arranque da aplicação.

Propriedades

client

Métodos

create(DatabaseRequest, RequestOptions)	Enviar um pedido para criar uma base de dados. Uma base de dados gere utilizadores, permissões e um conjunto de contentores. Cada Conta de Base de Dados do Azure Cosmos DB é capaz de suportar várias bases de dados nomeadas independentes, sendo a base de dados o contentor lógico dos dados. Cada Base de Dados é constituída por um ou mais contentores, cada um dos quais, por sua vez, contém um ou mais documentos. Uma vez que as bases de dados são um recurso administrativo, a Chave Mestra do Serviço será necessária para aceder e concluir com êxito qualquer ação com as APIs de Utilizador.
createIfNotExists(DatabaseRequest, RequestOptions)	Verifique se existe uma base de dados e, se não existir, crie-a. Esta ação fará uma operação de leitura com base no ID no body, se não for encontrada, uma operação de criação. Uma base de dados gere utilizadores, permissões e um conjunto de contentores. Cada Conta de Base de Dados do Azure Cosmos DB é capaz de suportar várias bases de dados nomeadas independentes, sendo a base de dados o contentor lógico dos dados. Cada Base de Dados é constituída por um ou mais contentores, cada um dos quais, por sua vez, contém um ou mais documentos. Uma vez que as bases de dados são um recurso administrativo, a Chave Mestra do Serviço será necessária para aceder e concluir com êxito qualquer ação com as APIs de Utilizador.
query(string | SqlQuerySpec, FeedOptions)	Consulta todas as bases de dados. Exemplo Leia todas as bases de dados para 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 todas as bases de dados. Exemplo Leia todas as bases de dados para 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ê todas as bases de dados. Exemplo Leia todas as bases de dados para matriz. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

Detalhes de Propriedade

client

client: CosmosClient

Valor de Propriedade

CosmosClient

Detalhes de Método

create(DatabaseRequest, RequestOptions)

Enviar um pedido para criar uma base de dados.

Uma base de dados gere utilizadores, permissões e um conjunto de contentores. Cada Conta de Base de Dados do Azure Cosmos DB é capaz de suportar várias bases de dados nomeadas independentes, sendo a base de dados o contentor lógico dos dados.

Cada Base de Dados é constituída por um ou mais contentores, cada um dos quais, por sua vez, contém um ou mais documentos. Uma vez que as bases de dados são um recurso administrativo, a Chave Mestra do Serviço será necessária para aceder e concluir com êxito qualquer ação com as APIs de Utilizador.

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

Parâmetros

body

DatabaseRequest

A DatabaseDefinition que representa a Base de Dados a ser criada.

options

RequestOptions

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

Devoluções

Promise<DatabaseResponse>

createIfNotExists(DatabaseRequest, RequestOptions)

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

Uma base de dados gere utilizadores, permissões e um conjunto de contentores. Cada Conta de Base de Dados do Azure Cosmos DB é capaz de suportar várias bases de dados nomeadas independentes, sendo a base de dados o contentor lógico dos dados.

Cada Base de Dados é constituída por um ou mais contentores, cada um dos quais, por sua vez, contém um ou mais documentos. Uma vez que as bases de dados são um recurso administrativo, a Chave Mestra do Serviço será necessária para aceder e concluir com êxito qualquer ação com as APIs de Utilizador.

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

Parâmetros

body

DatabaseRequest

A DatabaseDefinition que representa a Base de Dados a ser criada.

options

RequestOptions

Opções adicionais para o pedido

Devoluções

Promise<DatabaseResponse>

query(string | SqlQuerySpec, FeedOptions)

Consulta todas as bases de dados.

Exemplo

Leia todas as bases de dados para 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

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

Devoluções

QueryIterator<any>

QueryIterator Permite-lhe devolver todas as bases de dados numa matriz ou iterar uma de cada vez. *

query<T>(string | SqlQuerySpec, FeedOptions)

Consulta todas as bases de dados.

Exemplo

Leia todas as bases de dados para 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

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

Devoluções

QueryIterator<T>

QueryIterator Permite-lhe devolver todas as bases de dados numa matriz ou iterar uma de cada vez. *

readAll(FeedOptions)

Lê todas as bases de dados.

Exemplo

Leia todas as bases de dados para matriz. * typescript * const {body: databaseList} = await client.databases.readAll().fetchAll(); *

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

Parâmetros

options

FeedOptions

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

Devoluções

QueryIterator<DatabaseDefinition & Resource>

QueryIterator Permite-lhe devolver todas as bases de dados numa matriz ou iterar uma de cada vez. *