CosmosDatabase Classe

Paquet:

com.azure.cosmos

Artefact Maven:

com.azure:azure-cosmos:4.63.3

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

public class CosmosDatabase

Lire et supprimer des bases de données, mettre à jour le débit de base de données et effectuer des opérations sur les ressources enfants de manière synchrone

Résumé de la méthode

Modificateur et type	Méthode et description
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties) Crée un conteneur Cosmos.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Crée un conteneur Cosmos lors de la transmission d’options de requête supplémentaires.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Crée un conteneur Cosmos avec un paramètre de débit personnalisé.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options) Crée un conteneur Cosmos.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath) Créez un conteneur Cosmos.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Créez un conteneur Cosmos.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties) Créez un conteneur s’il n’existe pas d’id correspondant à l’ID dans l’objet properties.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties) Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID dans l’objet properties.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath) Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties) Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID.
CosmosUserResponse	createUser(CosmosUserProperties userProperties) Créer un utilisateur Cosmos.
CosmosDatabaseResponse	delete() Supprime la base de données Cosmos actuelle.
CosmosDatabaseResponse	delete(CosmosDatabaseRequestOptions options) Supprimez la base de données Cosmos actuelle tout en spécifiant des options de requête supplémentaires.
CosmosClientEncryptionKey	getClientEncryptionKey(String id) Obtient un objet de clé de chiffrementdu clientCosmossans effectuer d’appel de service
CosmosContainer	getContainer(String id) Obtient un conteneur Cosmos instance sans effectuer d’appel de service.
String	getId() Obtenez l’ID de la base de données Cosmos.
CosmosUser	getUser(String id) Obtient un utilisateur Cosmos instance sans passer d’appel de service.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec) Interroger des conteneurs dans la base de données active.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Interroger des conteneurs dans la base de données active.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query) Interroger des conteneurs dans la base de données active.
CosmosPagedIterable<CosmosContainerProperties>	queryContainers(String query, CosmosQueryRequestOptions options) Itérateur de conteneurs de requêtes.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec) Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query) Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.
CosmosPagedIterable<CosmosUserProperties>	queryUsers(String query, CosmosQueryRequestOptions options) Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.
CosmosDatabaseResponse	read() Lit la base de données Cosmos actuelle.
CosmosDatabaseResponse	read(CosmosDatabaseRequestOptions options) Lit la base de données Cosmos actuelle tout en spécifiant des options de requête supplémentaires.
CosmosPagedIterable<CosmosClientEncryptionKeyProperties>	readAllClientEncryptionKeys() Lit toutes les clés de chiffrement du client Cosmos dans une base de données.
CosmosPagedIterable<CosmosContainerProperties>	readAllContainers() Lisez tous les conteneurs de la base de données active.
CosmosPagedIterable<CosmosUserProperties>	readAllUsers() Lisez tous les utilisateurs Cosmos pour la base de données actuelle.
ThroughputResponse	readThroughput() Obtient le débit de la base de données active.
ThroughputResponse	replaceThroughput(ThroughputProperties throughputProperties) Définit le débit de la base de données actuelle.
CosmosUserResponse	upsertUser(CosmosUserProperties userProperties) Upserts un utilisateur Cosmos.

Méthodes héritées de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Détails de la méthode

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties)

Crée un conteneur Cosmos.

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

Paramètres:

containerProperties - Objet CosmosContainerProperties.

Retours:

CosmosContainerResponse avec le conteneur créé.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)

Crée un conteneur Cosmos lors de la transmission d’options de requête supplémentaires.

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

Paramètres:

containerProperties - Objet CosmosContainerProperties.

options - Objet CosmosContainerProperties.

Retours:

CosmosContainerResponse avec le conteneur créé.

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Crée un conteneur Cosmos avec un paramètre de débit personnalisé.

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);
 }

Paramètres:

containerProperties - Objet CosmosContainerProperties.

throughputProperties - propriétés de débit.

Retours:

CosmosContainerResponse avec le conteneur créé.

createContainer

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

Crée un conteneur 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);
 }

Paramètres:

containerProperties - propriétés du conteneur.

throughputProperties - propriétés de débit.

options - les options.

Retours:

réponse du conteneur cosmos.

createContainer

public CosmosContainerResponse createContainer(String id, String partitionKeyPath)

Créez un conteneur 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);
 }

Paramètres:

id - ID de conteneur.

partitionKeyPath - chemin de la clé de partition.

Retours:

réponse du conteneur cosmos.

createContainer

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

Créez un conteneur 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);
 }

Paramètres:

id - id.

partitionKeyPath - chemin de la clé de partition.

throughputProperties - propriétés de débit.

Retours:

réponse du conteneur cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties)

Créez un conteneur s’il n’existe pas d’id correspondant à l’ID dans l’objet properties.

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

Paramètres:

containerProperties - propriétés du conteneur.

Retours:

réponse du conteneur cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)

Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID dans l’objet properties.

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

Les propriétés de débit ne sont utilisées que si le conteneur spécifié n’existe pas et qu’un conteneur est alors créé.

Paramètres:

containerProperties - propriétés du conteneur.

throughputProperties - propriétés de débit pour le conteneur.

Retours:

réponse du conteneur cosmos.

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id, String partitionKeyPath)

Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID.

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

Paramètres:

id - id.

partitionKeyPath - chemin de la clé de partition.

Retours:

réponse du conteneur cosmos.

createContainerIfNotExists

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

Crée un conteneur Cosmos s’il n’existe pas de conteneur correspondant à l’ID.

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

Les propriétés de débit ne sont utilisées que si le conteneur spécifié n’existe pas et qu’un conteneur est alors créé.

Paramètres:

id - id.

partitionKeyPath - chemin de la clé de partition.

throughputProperties - propriétés de débit pour le conteneur.

Retours:

réponse du conteneur cosmos.

createUser

public CosmosUserResponse createUser(CosmosUserProperties userProperties)

Créer un utilisateur Cosmos.

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

Paramètres:

userProperties - les paramètres.

Retours:

réponse de l’utilisateur cosmos.

delete

public CosmosDatabaseResponse delete()

Supprime la base de données Cosmos actuelle.

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

Retours:

Objet CosmosDatabaseResponse.

delete

public CosmosDatabaseResponse delete(CosmosDatabaseRequestOptions options)

Supprimez la base de données Cosmos actuelle tout en spécifiant des options de requête supplémentaires.

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

Paramètres:

options - options de requête CosmosDatabaseRequestOptions .

Retours:

Objet CosmosDatabaseResponse.

getClientEncryptionKey

public CosmosClientEncryptionKey getClientEncryptionKey(String id)

Obtient un objet CosmosClientEncryptionKey sans effectuer d’appel de service

Paramètres:

id - ID du clientEncryptionKey

Retours:

Cosmos ClientEncryptionKey

getContainer

public CosmosContainer getContainer(String id)

Obtient un conteneur Cosmos instance sans effectuer d’appel de service.

Pour obtenir l’objet réel, une opération de lecture doit d’abord être effectuée.

Paramètres:

id - id du conteneur.

Retours:

Cosmos Container.

getId

public String getId()

Obtenez l’ID de la base de données Cosmos.

Retours:

ID de la base de données.

getUser

public CosmosUser getUser(String id)

Obtient un utilisateur Cosmos instance sans passer d’appel de service.

Pour obtenir l’objet réel, une opération de lecture doit d’abord être effectuée.

Paramètres:

id - id.

Retours:

l’utilisateur.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec)

Interroger des conteneurs dans la base de données active.

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

Paramètres:

querySpec - spécification de requête.

Retours:

Objet CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Interroger des conteneurs dans la base de données active.

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

Paramètres:

querySpec - spécification de requête.

options - les options.

Retours:

Objet CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query)

Interroger des conteneurs dans la base de données active.

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

Paramètres:

query - la requête.

Retours:

Objet CosmosPagedIterable<T>.

queryContainers

public CosmosPagedIterable queryContainers(String query, CosmosQueryRequestOptions options)

Itérateur de conteneurs de requêtes.

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

Paramètres:

query - la requête.

options - les options.

Retours:

Objet CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec)

Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.

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

Paramètres:

querySpec - spécification de requête.

Retours:

Objet CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.

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

Paramètres:

querySpec - spécification de requête.

options - les options.

Retours:

Objet CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query)

Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.

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

Paramètres:

query - la requête.

Retours:

Objet CosmosPagedIterable<T>.

queryUsers

public CosmosPagedIterable queryUsers(String query, CosmosQueryRequestOptions options)

Interrogez tous les utilisateurs Cosmos pour la base de données actuelle.

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

Paramètres:

query - la requête.

options - les options.

Retours:

Objet CosmosPagedIterable<T>.

read

public CosmosDatabaseResponse read()

Lit la base de données Cosmos actuelle. Récupérez les détails et les propriétés d’une base de données en fonction de son identificateur unique.

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

Retours:

Objet CosmosDatabaseResponse.

read

public CosmosDatabaseResponse read(CosmosDatabaseRequestOptions options)

Lit la base de données Cosmos actuelle tout en spécifiant des options de requête supplémentaires. Récupérez les détails et les propriétés d’une base de données en fonction de son identificateur unique.

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

Paramètres:

options - options de requête CosmosDatabaseRequestOptions .

Retours:

Lla CosmosDatabaseResponse

readAllClientEncryptionKeys

public CosmosPagedIterable readAllClientEncryptionKeys()

Lit toutes les clés de chiffrement du client Cosmos dans une base de données.

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

Retours:

a CosmosPagedIterable<T>.

readAllContainers

public CosmosPagedIterable readAllContainers()

Lisez tous les conteneurs de la base de données active.

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

Retours:

Objet CosmosPagedIterable<T>.

readAllUsers

public CosmosPagedIterable readAllUsers()

Lisez tous les utilisateurs Cosmos pour la base de données actuelle.

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

Retours:

Objet CosmosPagedIterable<T>.

readThroughput

public ThroughputResponse readThroughput()

Obtient le débit de la base de données active.

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

Retours:

réponse de débit.

replaceThroughput

public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)

Définit le débit de la base de données actuelle.

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);

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

Paramètres:

throughputProperties - propriétés de débit.

Retours:

réponse de débit.

upsertUser

public CosmosUserResponse upsertUser(CosmosUserProperties userProperties)

Upserts un utilisateur Cosmos.

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

Paramètres:

userProperties - les paramètres.

Retours:

réponse de l’utilisateur cosmos.