CosmosClient Classe

Pacote:

com.azure.cosmos

Artefato Maven:

com.azure:azure-cosmos:4.63.3

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

Implementações

Fechável

public final class CosmosClient
implements Closeable

Fornece uma representação lógica do lado do cliente do serviço do Azure Cosmos DB. As chamadas para as API do CosmosClient são bloqueadas para conclusão.

O CosmosClient é thread-safe. É recomendável manter uma única instância do CosmosClient por tempo de vida do aplicativo que permite o gerenciamento e o desempenho de conexões eficientes. A inicialização do CosmosClient é uma operação pesada – não use instâncias do CosmosClient 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 CosmosClient instância.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties) Cria um banco de dados do Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Cria um banco de dados.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Cria um banco de dados do Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Cria um banco de dados do Cosmos.
CosmosDatabaseResponse	createDatabase(String id) Cria um banco de dados do Cosmos.
CosmosDatabaseResponse	createDatabase(String id, ThroughputProperties throughputProperties) Cria um banco de dados do Cosmos.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id) Crie um banco de dados do Cosmos se ele ainda não existir no serviço.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Crie um banco de dados do Cosmos 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.
CosmosDatabase	getDatabase(String id) Obtém a instância do banco de dados cosmos sem fazer uma chamada de serviço.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consultar um banco de dados do Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Consultar um banco de dados do Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	readAllDatabases() Lê todos os bancos de dados do Cosmos.

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 CosmosClient instância.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)

Cria um banco de dados do Cosmos.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parâmetros:

databaseProperties - CosmosDatabaseProperties as propriedades do banco de dados.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Cria um banco de dados.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parâmetros:

databaseProperties - CosmosDatabaseProperties as propriedades do banco de dados.

options - as opções de solicitação.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Cria um banco de dados do Cosmos.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parâmetros:

databaseProperties - CosmosDatabaseProperties as propriedades do banco de dados.

throughputProperties - as propriedades de taxa de transferência.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabase

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

Cria um banco de dados do Cosmos.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parâmetros:

databaseProperties - CosmosDatabaseProperties as propriedades do banco de dados.

throughputProperties - as propriedades de taxa de transferência.

options - CosmosDatabaseRequestOptions as opções de solicitação.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabase

public CosmosDatabaseResponse createDatabase(String id)

Cria um banco de dados do Cosmos.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

Parâmetros:

id - a ID do banco de dados.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabase

public CosmosDatabaseResponse createDatabase(String id, ThroughputProperties throughputProperties)

Cria um banco de dados do Cosmos.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

Parâmetros:

id - a ID do banco de dados.

throughputProperties - as propriedades de taxa de transferência.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)

Crie um banco de dados do Cosmos se ele ainda não existir no serviço.

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabaseIfNotExists(databaseProperties);

Parâmetros:

id - a ID do banco de dados.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Crie um banco de dados do Cosmos se ele ainda não existir no serviço.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabaseIfNotExists(databaseName, throughputProperties);

As throughputProperties só serão usadas se o banco de dados especificado não existir e, portanto, um novo banco de dados será criado com throughputProperties.

Parâmetros:

id - a ID do banco de dados.

throughputProperties - as throughputProperties.

Retornos:

o CosmosDatabaseResponse com o banco de dados criado.

createGlobalThroughputControlConfigBuilder

public 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.

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 CosmosDatabase getDatabase(String id)

Obtém a instância do banco de dados cosmos sem fazer uma chamada de serviço.

Parâmetros:

id - a ID do banco de dados.

Retornos:

CosmosDatabase o banco de dados de sincronização do Cosmos.

queryDatabases

public CosmosPagedIterable queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consultar um banco de dados do Cosmos.

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

Parâmetros:

querySpec - SqlQuerySpec a especificação de consulta.

options - as opções de solicitação de consulta.

Retornos:

para CosmosPagedIterable<T> resposta de feed com os bancos de dados obtidos.

queryDatabases

public CosmosPagedIterable queryDatabases(String query, CosmosQueryRequestOptions options)

Consultar um banco de dados do Cosmos.

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

Parâmetros:

query - a consulta.

options - CosmosQueryRequestOptionsas opções de feed.

Retornos:

para CosmosPagedIterable<T> resposta de feed com os bancos de dados obtidos.

readAllDatabases

public CosmosPagedIterable readAllDatabases()

Lê todos os bancos de dados do Cosmos.

CosmosPagedIterable<CosmosDatabaseProperties> cosmosDatabaseProperties =
     cosmosClient.readAllDatabases();
 cosmosDatabaseProperties.forEach(databaseProperties -> {
     System.out.println(databaseProperties);
 });

Retornos:

para CosmosPagedIterable<T> resposta de feed com os bancos de dados de leitura.