CosmosAsyncClient Classe

Paquet:

com.azure.cosmos

Artefact Maven:

com.azure:azure-cosmos:4.62.0

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

Implémente

Refermable

public final class CosmosAsyncClient
implements Closeable

Fournit une représentation logique côté client du service Azure Cosmos DB. Ce client asynchrone est utilisé pour configurer et exécuter des demandes sur le service.

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

Résumé de la méthode

Modificateur et type	Méthode et description
void	close() Fermez cette CosmosAsyncClient instance et nettoie les ressources.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabase(String id) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabase(String id, ThroughputProperties throughputProperties) Crée une base de données.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties) CRÉEz une base de données si elle n’existe pas déjà sur le service.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id) Créez une base de données si elle n’existe pas déjà sur le service.
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) Créez une base de données 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.
CosmosAsyncDatabase	getDatabase(String id) Obtient un objet de base de données sans effectuer d’appel de service.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) Requête pour les bases de données.
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) Requête pour les bases de données.
CosmosPagedFlux<CosmosDatabaseProperties>	readAllDatabases() Lit toutes les bases de données.

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 CosmosAsyncClient instance et nettoie les ressources.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties)

Crée une base de données. Après l’abonnement, l’opération est effectuée. En Mono cas de réussite de l’exécution, le contient une seule réponse de ressource avec la base de données créée. En cas d’échec, l’erreur Mono sera générée.

Paramètres:

databaseProperties - CosmosDatabaseProperties.

Retours:

contenant Mono la réponse de base de données cosmos unique avec la base de données créée ou une erreur.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Crée une base de données. Après l’abonnement, l’opération est effectuée. En Mono cas de réussite de l’exécution, le contient une seule réponse de ressource avec la base de données créée. En cas d’échec, l’erreur Mono sera générée.

Paramètres:

databaseProperties - CosmosDatabaseProperties.

options - CosmosDatabaseRequestOptions.

Retours:

contenant Mono la réponse de base de données cosmos unique avec la base de données créée ou une erreur.

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Crée une base de données. Après l’abonnement, l’opération est effectuée. En Mono cas de réussite de l’exécution, le contient une seule réponse de ressource avec la base de données créée. En cas d’échec, l’erreur Mono sera générée.

Paramètres:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - propriétés de débit de la base de données.

Retours:

contenant Mono la réponse de base de données cosmos unique avec la base de données créée ou une erreur.

createDatabase

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

Crée une base de données. Après l’abonnement, l’opération est effectuée. En Mono cas de réussite de l’exécution, le contient une seule réponse de ressource avec la base de données créée. En cas d’échec, l’erreur Mono sera générée.

Paramètres:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - propriétés de débit de la base de données.

options - CosmosDatabaseRequestOptions.

Retours:

contenant Mono la réponse de base de données cosmos unique avec la base de données créée ou une erreur.

createDatabase

public Mono createDatabase(String id)

Crée une base de données. Après l’abonnement, l’opération est effectuée. En Mono cas de réussite de l’exécution, le contient une seule réponse de ressource avec la base de données créée. En cas d’échec, l’erreur Mono sera générée.

Paramètres:

id - id de la base de données.

Retours:

Mono contenant la réponse de base de données cosmos unique avec la base de données créée ou une erreur.

createDatabase

public Mono createDatabase(String id, ThroughputProperties throughputProperties)

Crée une base de données.

Paramètres:

id - id.

throughputProperties - débitProperties.

Retours:

le mono.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

CRÉEz une base de données si elle n’existe pas déjà sur le service. En Mono cas de réussite de l’exécution, le contient une seule réponse de base de données Cosmos avec la base de données créée ou existante.

Paramètres:

databaseProperties - CosmosDatabaseProperties.

Retours:

Mono contenant la réponse de la base de données Cosmos avec la base de données créée ou existante, ou une erreur.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id)

Créez une base de données si elle n’existe pas déjà sur le service. En Mono cas de réussite de l’exécution, le contient une seule réponse de base de données Cosmos avec la base de données créée ou existante.

Paramètres:

id - ID de la base de données.

Retours:

Mono contenant la réponse de la base de données Cosmos avec la base de données créée ou existante, ou une erreur.

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Créez une base de données si elle n’existe pas déjà sur le service. Les propriétés de débit ne sont utilisées que si la base de données spécifiée n’existe pas et qu’une nouvelle base de données est créée avec throughputProperties. En Mono cas de réussite de l’exécution, le contient une seule réponse de base de données Cosmos avec la base de données créée ou existante.

Paramètres:

id - id.

throughputProperties - débitProperties.

Retours:

le mono.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Créez le générateur de configuration du 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 CosmosAsyncDatabase getDatabase(String id)

Obtient un objet de base de données sans effectuer d’appel de service.

Paramètres:

id - nom de la base de données.

Retours:

CosmosAsyncDatabase.

queryDatabases

public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Requête pour les bases de données. Après l’abonnement, l’opération est effectuée. contient CosmosPagedFlux<T> une ou plusieurs réponses de flux des bases de données lues. En cas d’échec, l’erreur CosmosPagedFlux<T> will.

Paramètres:

querySpec - spécification de requête SQL.

options - options de flux.

Retours:

contenant une CosmosPagedFlux<T> ou plusieurs pages de réponse de flux de bases de données lues ou une erreur.

queryDatabases

public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)

Requête pour les bases de données. Après l’abonnement, l’opération est effectuée. contient CosmosPagedFlux<T> une ou plusieurs réponses de flux des bases de données lues. En cas d’échec, l’erreur CosmosPagedFlux<T> will.

Paramètres:

query - la requête.

options - options de flux.

Retours:

contenant une CosmosPagedFlux<T> ou plusieurs pages de réponse de flux de bases de données lues ou une erreur.

readAllDatabases

public CosmosPagedFlux readAllDatabases()

Lit toutes les bases de données. Après l’abonnement, l’opération est effectuée. contient CosmosPagedFlux<T> une ou plusieurs réponses de flux des bases de données lues. En cas d’échec, l’erreur CosmosPagedFlux<T> will.

Retours:

contenant une CosmosPagedFlux<T> ou plusieurs pages de réponse de flux de bases de données lues ou une erreur.