CosmosClient Classe

Paquet:

com.azure.cosmos

Artefact Maven:

com.azure:azure-cosmos:4.63.3

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

Implémente

Refermable

public final class CosmosClient
implements Closeable

Fournit une représentation logique côté client du service Azure Cosmos DB. Les appels à l’API CosmosClient sont bloqués pour être terminés.

CosmosClient est thread-safe. Il est recommandé de conserver une seule instance de CosmosClient par durée de vie de l’application, ce qui permet une gestion des connexions et des performances efficaces. L’initialisation de CosmosClient est une opération lourde : n’utilisez pas d’initialisation d’instances CosmosClient comme informations d’identification ou validations de connectivité réseau.

Résumé de la méthode

Modificateur et type	Méthode et description
void	close() Fermez cette CosmosClient instance.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties) Crée une base de données Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Crée une base de données.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Crée une base de données Cosmos.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Crée une base de données Cosmos.
CosmosDatabaseResponse	createDatabase(String id) Crée une base de données Cosmos.
CosmosDatabaseResponse	createDatabase(String id, ThroughputProperties throughputProperties) Crée une base de données Cosmos.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id) Créez une base de données Cosmos si elle n’existe pas déjà sur le service.
CosmosDatabaseResponse	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Créez une base de données Cosmos si elle n’existe pas déjà sur le service.
GlobalThroughputControlConfigBuilder	createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) Créez un générateur de configuration de contrôle de débit global qui sera utilisé pour générer GlobalThroughputControlConfig.
CosmosDatabase	getDatabase(String id) Obtient la base de données Cosmos instance sans effectuer d’appel de service.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Interroger une base de données Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Interroger une base de données Cosmos.
CosmosPagedIterable<CosmosDatabaseProperties>	readAllDatabases() Lit toutes les bases de données 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

close

public void close()

Fermez cette CosmosClient instance.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)

Crée une base de données Cosmos.

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

Paramètres:

databaseProperties - CosmosDatabaseProperties propriétés de la base de données.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Crée une base de données.

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

Paramètres:

databaseProperties - CosmosDatabaseProperties propriétés de la base de données.

options - les options de requête.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Crée une base de données Cosmos.

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

Paramètres:

databaseProperties - CosmosDatabaseProperties propriétés de la base de données.

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

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabase

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

Crée une base de données Cosmos.

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

Paramètres:

databaseProperties - CosmosDatabaseProperties propriétés de la base de données.

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

options - CosmosDatabaseRequestOptions les options de requête.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabase

public CosmosDatabaseResponse createDatabase(String id)

Crée une base de données Cosmos.

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

Paramètres:

id - ID de la base de données.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabase

public CosmosDatabaseResponse createDatabase(String id, ThroughputProperties throughputProperties)

Crée une base de données Cosmos.

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

Paramètres:

id - ID de la base de données.

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

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)

Créez une base de données Cosmos si elle n’existe pas déjà sur le service.

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

Paramètres:

id - ID de la base de données.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Créez une base de données Cosmos si elle n’existe pas déjà sur le service.

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

Les propriétés de débit ne seront utilisées que si la base de données spécifiée n’existe pas et qu’une nouvelle base de données sera créée avec débitProperties.

Paramètres:

id - ID de la base de données.

throughputProperties - débitProperties.

Retours:

avec CosmosDatabaseResponse la base de données créée.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Créez un générateur de configuration de contrôle de débit global qui sera utilisé pour générer GlobalThroughputControlConfig.

Paramètres:

databaseId - ID de base de données du conteneur de contrôle.

containerId - ID de conteneur du conteneur de contrôle.

Retours:

Un GlobalThroughputControlConfigBuilder.

getDatabase

public CosmosDatabase getDatabase(String id)

Obtient la base de données Cosmos instance sans effectuer d’appel de service.

Paramètres:

id - ID de la base de données.

Retours:

CosmosDatabase base de données de synchronisation cosmos.

queryDatabases

public CosmosPagedIterable queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Interroger une base de données Cosmos.

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

Paramètres:

querySpec - SqlQuerySpec spécification de requête.

options - les options de requête.

Retours:

pour la CosmosPagedIterable<T> réponse de flux avec les bases de données obtenues.

queryDatabases

public CosmosPagedIterable queryDatabases(String query, CosmosQueryRequestOptions options)

Interroger une base de données Cosmos.

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

Paramètres:

query - la requête.

options - CosmosQueryRequestOptionsoptions de flux.

Retours:

pour la CosmosPagedIterable<T> réponse de flux avec les bases de données obtenues.

readAllDatabases

public CosmosPagedIterable readAllDatabases()

Lit toutes les bases de données Cosmos.

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

Retours:

pour la CosmosPagedIterable<T> réponse de flux avec les bases de données lues.