CosmosDatabase Classe

Pacote:

com.azure.cosmos

Artefato Maven:

com.azure:azure-cosmos:4.63.3

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

public class CosmosDatabase

Executar bancos de dados de leitura e exclusão, atualizar a taxa de transferência do banco de dados e executar operações em recursos filho de maneira síncrona

Resumo do método

Modificador e tipo	Método e descrição
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties) Cria um contêiner do Cosmos.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Cria um contêiner do Cosmos ao passar opções de solicitação adicionais.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Cria um contêiner do Cosmos com configuração de taxa de transferência personalizada.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options) Cria um contêiner do Cosmos.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath) Criar um contêiner do Cosmos.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Criar um contêiner do Cosmos.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties) Crie um contêiner se um correspondente à ID no objeto properties não existir.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Cria um contêiner do Cosmos se um correspondente à ID no objeto properties não existir.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath) Cria um contêiner do Cosmos se um correspondente à ID não existir.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Cria um contêiner do Cosmos se um correspondente à ID não existir.
CosmosUserResponse	createUser(CosmosUserProperties userProperties) Criar usuário do Cosmos.
CosmosDatabaseResponse	delete() Exclui o banco de dados cosmos atual.
CosmosDatabaseResponse	delete(CosmosDatabaseRequestOptions options) Exclua o banco de dados cosmos atual ao especificar opções de solicitação adicionais.
CosmosClientEncryptionKey	getClientEncryptionKey(String id) Obtém um objeto chave de criptografiade clientedo Cosmossem fazer uma chamada de serviço
CosmosContainer	getContainer(String id) Obtém uma instância de contêiner do Cosmos sem fazer uma chamada de serviço.
String	getId() Obtenha a ID do banco de dados do Cosmos.
CosmosUser	getUser(String id) Obtém uma instância de usuário do Cosmos sem fazer uma chamada de serviço.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec) Consultar contêineres no banco de dados atual.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consultar contêineres no banco de dados atual.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query) Consultar contêineres no banco de dados atual.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query, CosmosQueryRequestOptions options) Iterador de contêineres de consulta.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec) Consulte todos os usuários do Cosmos para o banco de dados atual.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Consulte todos os usuários do Cosmos para o banco de dados atual.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query) Consulte todos os usuários do Cosmos para o banco de dados atual.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query, CosmosQueryRequestOptions options) Consulte todos os usuários do Cosmos para o banco de dados atual.
CosmosDatabaseResponse	read() Lê o banco de dados cosmos atual.
CosmosDatabaseResponse	read(CosmosDatabaseRequestOptions options) Lê o banco de dados cosmos atual ao especificar opções de solicitação adicionais.
CosmosPagedIterable<CosmosClientEncryptionKeyProperties>	readAllClientEncryptionKeys() Lê todas as chaves de criptografia do cliente cosmos em um banco de dados.
CosmosPagedIterable<CosmosContainerProperties>	readAllContainers() Leia todos os contêineres no banco de dados atual.
CosmosPagedIterable<CosmosUserProperties>	readAllUsers() Leia todos os usuários do Cosmos para o banco de dados atual.
ThroughputResponse	readThroughput() Obtém a taxa de transferência do banco de dados atual.
ThroughputResponse	replaceThroughput(ThroughputProperties throughputProperties) Define a taxa de transferência do banco de dados atual.
CosmosUserResponse	upsertUser(CosmosUserProperties userProperties) Upserts um usuário do Cosmos.

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do método

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties)

Cria um contêiner do Cosmos.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(containerProperties);
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

containerProperties - o CosmosContainerProperties.

Retornos:

o CosmosContainerResponse com o contêiner criado.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)

Cria um contêiner do Cosmos ao passar opções de solicitação adicionais.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(containerProperties);
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

containerProperties - o CosmosContainerProperties.

options - o CosmosContainerProperties.

Retornos:

o CosmosContainerResponse com o contêiner criado.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Cria um contêiner do Cosmos com configuração de taxa de transferência personalizada.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerProperties,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

containerProperties - o CosmosContainerProperties.

throughputProperties - as propriedades de taxa de transferência.

Retornos:

o CosmosContainerResponse com o contêiner criado.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)

Cria um contêiner do Cosmos.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerProperties,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

containerProperties - as propriedades do contêiner.

throughputProperties - as propriedades de taxa de transferência.

options - as opções.

Retornos:

a resposta do contêiner cosmos.

createContainer

public CosmosContainerResponse createContainer(String id, String partitionKeyPath)

Criar um contêiner do Cosmos.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerId,
         partitionKeyPath,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

id - a ID do contêiner.

partitionKeyPath - o caminho da chave de partição.

Retornos:

a resposta do contêiner cosmos.

createContainer

public CosmosContainerResponse createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)

Criar um contêiner do Cosmos.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 try {
     CosmosContainerResponse container = cosmosDatabase.createContainer(
         containerId,
         partitionKeyPath,
         throughputProperties
     );
 } catch (CosmosException ce) {
     System.out.println("Failed to create container: " + ce);
 }

Parâmetros:

id - a ID.

partitionKeyPath - o caminho da chave de partição.

throughputProperties - as propriedades de taxa de transferência.

Retornos:

a resposta do contêiner cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties)

Crie um contêiner se um correspondente à ID no objeto properties não existir.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(containerProperties);

Parâmetros:

containerProperties - as propriedades do contêiner.

Retornos:

a resposta do contêiner cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Cria um contêiner do Cosmos se um correspondente à ID no objeto properties não existir.

CosmosContainerProperties containerProperties =
     new CosmosContainerProperties(containerId, partitionKeyDefinition);
 ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoScaleMaxThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerProperties,
     throughputProperties
 );

As propriedades de taxa de transferência só serão usadas se o contêiner especificado não existir e, portanto, um novo contêiner for criado.

Parâmetros:

containerProperties - as propriedades do contêiner.

throughputProperties - as propriedades de taxa de transferência para o contêiner.

Retornos:

a resposta do contêiner cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id, String partitionKeyPath)

Cria um contêiner do Cosmos se um correspondente à ID não existir.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerId,
     partitionKeyPath,
     throughputProperties
 );

Parâmetros:

id - a ID.

partitionKeyPath - o caminho da chave de partição.

Retornos:

a resposta do contêiner cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)

Cria um contêiner do Cosmos se um correspondente à ID não existir.

ThroughputProperties throughputProperties =
     ThroughputProperties.createAutoscaledThroughput(autoscaledThroughput);
 CosmosContainerResponse container = cosmosDatabase.createContainerIfNotExists(
     containerId,
     partitionKeyPath,
     throughputProperties
 );

As propriedades de taxa de transferência só serão usadas se o contêiner especificado não existir e, portanto, um novo contêiner for criado.

Parâmetros:

id - a ID.

partitionKeyPath - o caminho da chave de partição.

throughputProperties - as propriedades de taxa de transferência para o contêiner.

Retornos:

a resposta do contêiner cosmos.

createUser

public CosmosUserResponse createUser(CosmosUserProperties userProperties)

Criar usuário do Cosmos.

CosmosUserProperties userProperties = new CosmosUserProperties();
 userProperties.setId(userId);
 cosmosDatabase.createUser(userProperties);

Parâmetros:

userProperties - as configurações.

Retornos:

a resposta do usuário do Cosmos.

delete

public CosmosDatabaseResponse delete()

Exclui o banco de dados cosmos atual.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse deleteResponse = cosmosDatabase.delete();

Retornos:

o CosmosDatabaseResponse.

delete

public CosmosDatabaseResponse delete(CosmosDatabaseRequestOptions options)

Exclua o banco de dados cosmos atual ao especificar opções de solicitação adicionais.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse deleteResponse = cosmosDatabase.delete();

Parâmetros:

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

Retornos:

o CosmosDatabaseResponse.

getClientEncryptionKey

public CosmosClientEncryptionKey getClientEncryptionKey(String id)

Obtém um objeto CosmosClientEncryptionKey sem fazer uma chamada de serviço

Parâmetros:

id - id do clientEncryptionKey

Retornos:

Cosmos ClientEncryptionKey

getContainer

public CosmosContainer getContainer(String id)

Obtém uma instância de contêiner do Cosmos sem fazer uma chamada de serviço.

Para obter o objeto real, uma operação de leitura deve ser executada primeiro.

Parâmetros:

id - id do contêiner.

Retornos:

Contêiner do Cosmos.

getId

public String getId()

Obtenha a ID do banco de dados do Cosmos.

Retornos:

a ID do banco de dados.

getUser

public CosmosUser getUser(String id)

Obtém uma instância de usuário do Cosmos sem fazer uma chamada de serviço.

Para obter o objeto real, uma operação de leitura deve ser executada primeiro.

Parâmetros:

id - a ID.

Retornos:

o usuário.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec)

Consultar contêineres no banco de dados atual.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parâmetros:

querySpec - a especificação de consulta.

Retornos:

o CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consultar contêineres no banco de dados atual.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parâmetros:

querySpec - a especificação de consulta.

options - as opções.

Retornos:

o CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query)

Consultar contêineres no banco de dados atual.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parâmetros:

query - a consulta.

Retornos:

o CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query, CosmosQueryRequestOptions options)

Iterador de contêineres de consulta.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.queryContainers("SELECT * FROM DB_NAME");
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Parâmetros:

query - a consulta.

options - as opções.

Retornos:

o CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec)

Consulte todos os usuários do Cosmos para o banco de dados atual.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parâmetros:

querySpec - a especificação de consulta.

Retornos:

o CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Consulte todos os usuários do Cosmos para o banco de dados atual.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parâmetros:

querySpec - a especificação de consulta.

options - as opções.

Retornos:

o CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query)

Consulte todos os usuários do Cosmos para o banco de dados atual.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parâmetros:

query - a consulta.

Retornos:

o CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query, CosmosQueryRequestOptions options)

Consulte todos os usuários do Cosmos para o banco de dados atual.

CosmosPagedIterable<CosmosUserProperties> userPropertiesList =
     cosmosDatabase.queryUsers("SELECT * FROM DB_NAME");
 userPropertiesList.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Parâmetros:

query - a consulta.

options - as opções.

Retornos:

o CosmosPagedIterable<T>.

read

public CosmosDatabaseResponse read()

Lê o banco de dados cosmos atual. Busque os detalhes e as propriedades de um banco de dados com base em seu identificador exclusivo.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse readResponse = cosmosDatabase.read();

Retornos:

o CosmosDatabaseResponse.

read

public CosmosDatabaseResponse read(CosmosDatabaseRequestOptions options)

Lê o banco de dados cosmos atual ao especificar opções de solicitação adicionais. Busque os detalhes e as propriedades de um banco de dados com base em seu identificador exclusivo.

CosmosDatabase cosmosDatabase = cosmosClient
     .getDatabase("<YOUR DATABASE NAME>");
 CosmosDatabaseResponse readResponse = cosmosDatabase.read();

Parâmetros:

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

Retornos:

O CosmosDatabaseResponse

readAllClientEncryptionKeys

public CosmosPagedIterable readAllClientEncryptionKeys()

Lê todas as chaves de criptografia do cliente cosmos em um banco de dados.

CosmosPagedIterable<CosmosClientEncryptionKeyProperties> clientEncryptionKeys =
     cosmosDatabase.readAllClientEncryptionKeys();
 clientEncryptionKeys.forEach(encryptionKeyProperties ->
     System.out.println(clientEncryptionKeys)
 );

Retornos:

um CosmosPagedIterable<T>.

readAllContainers

public CosmosPagedIterable readAllContainers()

Leia todos os contêineres no banco de dados atual.

CosmosPagedIterable<CosmosContainerProperties> cosmosContainersList =
     cosmosDatabase.readAllContainers();
 cosmosContainersList.forEach(cosmosContainerProperties -> {
     System.out.println(cosmosContainerProperties);
 });

Retornos:

o CosmosPagedIterable<T>.

readAllUsers

public CosmosPagedIterable readAllUsers()

Leia todos os usuários do Cosmos para o banco de dados atual.

CosmosPagedIterable<CosmosUserProperties> cosmosUserProperties = cosmosDatabase.readAllUsers();
 cosmosUserProperties.forEach(userProperties -> {
     System.out.println(userProperties);
 });

Retornos:

o CosmosPagedIterable<T>.

readThroughput

public ThroughputResponse readThroughput()

Obtém a taxa de transferência do banco de dados atual.

ThroughputResponse throughputResponse = cosmosDatabase.readThroughput();
 System.out.println(throughputResponse);

Retornos:

a resposta de taxa de transferência.

replaceThroughput

public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)

Define a taxa de transferência do banco de dados atual.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);

 ThroughputResponse throughputResponse = cosmosDatabase.replaceThroughput(throughputProperties);
 System.out.println(throughputResponse);

Parâmetros:

throughputProperties - as propriedades de taxa de transferência.

Retornos:

a resposta de taxa de transferência.

upsertUser

public CosmosUserResponse upsertUser(CosmosUserProperties userProperties)

Upserts um usuário do Cosmos.

CosmosUserProperties userProperties = new CosmosUserProperties();
 userProperties.setId(userId);
 cosmosDatabase.upsertUser(userProperties);

Parâmetros:

userProperties - as configurações.

Retornos:

a resposta do usuário do Cosmos.