CosmosAsyncClient Classe

Pacote:

com.azure.cosmos

Artefato Maven:

com.azure:azure-cosmos:4.63.4

• java.lang.Object
• • com.azure.cosmos.CosmosAsyncClient

Implementações

Fechável

public final class CosmosAsyncClient
implements Closeable

Fornece uma representação lógica do lado do cliente do serviço do Azure Cosmos DB. Esse cliente assíncrono é usado para configurar e executar solicitações no serviço.

CosmosAsyncClient é thread-safe. É recomendável manter uma única instância do CosmosAsyncClient por tempo de vida do aplicativo, o que permite o gerenciamento e o desempenho de conexões eficientes. A inicialização do CosmosAsyncClient é uma operação pesada – não use as instâncias cosmosAsyncClient de inicialização como credenciais ou validações de conectividade de rede.

Resumo do método

Modificador e tipo	Método e descrição
void	close() Feche essa CosmosAsyncClient instância e limpe os recursos.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabase(String id) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabase(String id, ThroughputProperties throughputProperties) Cria um banco de dados.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties) CRIE um Banco de Dados se ele ainda não existir no serviço.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id) Crie um Banco de Dados se ele ainda não existir no serviço.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Crie um Banco de Dados se ele ainda não existir no serviço.
GlobalThroughputControlConfigBuilder	createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Crie um construtor de configuração de controle de taxa de transferência global que será usado para criar GlobalThroughputControlConfig.
CosmosAsyncDatabase	getDatabase(String id) Obtém um objeto de banco de dados sem fazer uma chamada de serviço.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consultar bancos de dados.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Consultar bancos de dados.
CosmosPagedFlux<CosmosDatabaseProperties>	readAllDatabases() Lê todos os bancos de dados.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

close

public void close()

Feche essa CosmosAsyncClient instância e limpe os recursos.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties)

Cria um banco de dados. Após a assinatura, a operação será executada. O Mono após a conclusão bem-sucedida conterá uma única resposta de recurso com o banco de dados criado. Em caso de falha, o Mono erro será.

Parâmetros:

databaseProperties - CosmosDatabaseProperties.

Retornos:

um Mono que contém a resposta de banco de dados cosmos único com o banco de dados criado ou um erro.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Cria um banco de dados. Após a assinatura, a operação será executada. O Mono após a conclusão bem-sucedida conterá uma única resposta de recurso com o banco de dados criado. Em caso de falha, o Mono erro será.

Parâmetros:

databaseProperties - CosmosDatabaseProperties.

options - CosmosDatabaseRequestOptions.

Retornos:

um Mono que contém a resposta de banco de dados cosmos único com o banco de dados criado ou um erro.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Cria um banco de dados. Após a assinatura, a operação será executada. O Mono após a conclusão bem-sucedida conterá uma única resposta de recurso com o banco de dados criado. Em caso de falha, o Mono erro será.

Parâmetros:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - as propriedades de taxa de transferência para o banco de dados.

Retornos:

um Mono que contém a resposta de banco de dados cosmos único com o banco de dados criado ou um erro.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)

Cria um banco de dados. Após a assinatura, a operação será executada. O Mono após a conclusão bem-sucedida conterá uma única resposta de recurso com o banco de dados criado. Em caso de falha, o Mono erro será.

Parâmetros:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - as propriedades de taxa de transferência para o banco de dados.

options - CosmosDatabaseRequestOptions.

Retornos:

um Mono que contém a resposta de banco de dados cosmos único com o banco de dados criado ou um erro.

createDatabase

public Mono createDatabase(String id)

Cria um banco de dados. Após a assinatura, a operação será executada. O Mono após a conclusão bem-sucedida conterá uma única resposta de recurso com o banco de dados criado. Em caso de falha, o Mono erro será.

Parâmetros:

id - id do banco de dados.

Retornos:

um Mono que contém a resposta de banco de dados cosmos único com o banco de dados criado ou um erro.

createDatabase

public Mono createDatabase(String id, ThroughputProperties throughputProperties)

Cria um banco de dados.

Parâmetros:

id - a ID.

throughputProperties - as throughputProperties.

Retornos:

o mono.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

CRIE um Banco de Dados se ele ainda não existir no serviço. O Mono após a conclusão bem-sucedida conterá uma única resposta de banco de dados cosmos com o banco de dados criado ou existente.

Parâmetros:

databaseProperties - CosmosDatabaseProperties.

Retornos:

um Mono que contém a resposta do banco de dados cosmos com o banco de dados criado ou existente ou um erro.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id)

Crie um Banco de Dados se ele ainda não existir no serviço. O Mono após a conclusão bem-sucedida conterá uma única resposta de banco de dados cosmos com o banco de dados criado ou existente.

Parâmetros:

id - a ID do banco de dados.

Retornos:

um Mono que contém a resposta do banco de dados cosmos com o banco de dados criado ou existente ou um erro.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Crie um Banco de Dados se ele ainda não existir no serviço. As throughputProperties só serão usadas se o banco de dados especificado não existir e, portanto, um novo banco de dados for criado com throughputProperties. O Mono após a conclusão bem-sucedida conterá uma única resposta de banco de dados cosmos com o banco de dados criado ou existente.

Parâmetros:

id - a ID.

throughputProperties - as throughputProperties.

Retornos:

o mono.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Crie o construtor de configuração de controle de taxa de transferência global que será usado para compilar GlobalThroughputControlConfig.

Parâmetros:

databaseId - A ID do banco de dados do contêiner de controle.

containerId - A ID do contêiner de controle.

Retornos:

Uma GlobalThroughputControlConfigBuilder.

getDatabase

public CosmosAsyncDatabase getDatabase(String id)

Obtém um objeto de banco de dados sem fazer uma chamada de serviço.

Parâmetros:

id - nome do banco de dados.

Retornos:

CosmosAsyncDatabase.

queryDatabases

public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consultar bancos de dados. Após a assinatura, a operação será executada. O CosmosPagedFlux<T> conterá uma ou várias respostas de feed dos bancos de dados de leitura. Em caso de falha, o CosmosPagedFlux<T> erro será.

Parâmetros:

querySpec - a especificação de consulta SQL.

options - as opções de feed.

Retornos:

um CosmosPagedFlux<T> que contém uma ou várias páginas de resposta de feed de bancos de dados de leitura ou um erro.

queryDatabases

public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)

Consultar bancos de dados. Após a assinatura, a operação será executada. O CosmosPagedFlux<T> conterá uma ou várias respostas de feed dos bancos de dados de leitura. Em caso de falha, o CosmosPagedFlux<T> erro será.

Parâmetros:

query - a consulta.

options - as opções de feed.

Retornos:

um CosmosPagedFlux<T> que contém uma ou várias páginas de resposta de feed de bancos de dados de leitura ou um erro.

readAllDatabases

public CosmosPagedFlux readAllDatabases()

Lê todos os bancos de dados. Após a assinatura, a operação será executada. O CosmosPagedFlux<T> conterá uma ou várias respostas de feed dos bancos de dados de leitura. Em caso de falha, o CosmosPagedFlux<T> erro será.

Retornos:

um CosmosPagedFlux<T> que contém uma ou várias páginas de resposta de feed de bancos de dados de leitura ou um erro.