Share via

CosmosAsyncClient Class

Package:
com.azure.cosmos
Maven Artifact:
com.azure:azure-cosmos:4.73.0
  • java.lang.Object
    • com.azure.cosmos.CosmosAsyncClient

Implements

Closeable

public final class CosmosAsyncClient
implements Closeable

Provides a client-side logical representation of the Azure Cosmos DB service. This asynchronous client is used to configure and execute requests against the service.

CosmosAsyncClient is thread-safe. It's recommended to maintain a single instance of CosmosAsyncClient per lifetime of the application which enables efficient connection management and performance. CosmosAsyncClient initialization is a heavy operation - don't use initialization CosmosAsyncClient instances as credentials or network connectivity validations.

Method Summary

Modifier and Type Method and Description
void close()

Close this CosmosAsyncClient instance and cleans up the resources.
Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabase(String id)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabase(String id, ThroughputProperties throughputProperties)

Creates a database.
Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

CREATE a Database if it does not already exist on the service.
Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(String id)

Create a Database if it does not already exist on the service.
Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Create a Database if it does not already exist on the service.
GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Create global throughput control config builder which will be used to build GlobalThroughputControlConfig.
CosmosAsyncDatabase getDatabase(String id)

Gets a database object without making a service call.
CosmosPagedFlux<CosmosDatabaseProperties> queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Query for databases.
CosmosPagedFlux<CosmosDatabaseProperties> queryDatabases(String query, CosmosQueryRequestOptions options)

Query for databases.
CosmosPagedFlux<CosmosDatabaseProperties> readAllDatabases()

Reads all databases.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

close

public void close()

Close this CosmosAsyncClient instance and cleans up the resources.

createDatabase

public Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties)

Creates a database. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created database. In case of failure the Mono will error.

Parameters:

databaseProperties - CosmosDatabaseProperties.

Returns:

an Mono containing the single cosmos database response with the created database or an error.

createDatabase

public Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

Creates a database. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created database. In case of failure the Mono will error.

Parameters:

databaseProperties - CosmosDatabaseProperties.

Returns:

an Mono containing the single cosmos database response with the created database or an error.

createDatabase

public Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

Creates a database. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created database. In case of failure the Mono will error.

Parameters:

databaseProperties - CosmosDatabaseProperties.
throughputProperties - the throughput properties for the database.

Returns:

an Mono containing the single cosmos database response with the created database or an error.

createDatabase

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

Creates a database. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created database. In case of failure the Mono will error.

Parameters:

databaseProperties - CosmosDatabaseProperties.
throughputProperties - the throughput properties for the database.

Returns:

an Mono containing the single cosmos database response with the created database or an error.

createDatabase

public Mono<CosmosDatabaseResponse> createDatabase(String id)

Creates a database. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created database. In case of failure the Mono will error.

Parameters:

id - id of the database.

Returns:

a Mono containing the single cosmos database response with the created database or an error.

createDatabase

public Mono<CosmosDatabaseResponse> createDatabase(String id, ThroughputProperties throughputProperties)

Creates a database.

Parameters:

id - the id.
throughputProperties - the throughputProperties.

Returns:

the mono.

createDatabaseIfNotExists

public Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

CREATE a Database if it does not already exist on the service. The Mono upon successful completion will contain a single cosmos database response with the created or existing database.

Parameters:

databaseProperties - CosmosDatabaseProperties.

Returns:

a Mono containing the cosmos database response with the created or existing database or an error.

createDatabaseIfNotExists

public Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(String id)

Create a Database if it does not already exist on the service. The Mono upon successful completion will contain a single cosmos database response with the created or existing database.

Parameters:

id - the id of the database.

Returns:

a Mono containing the cosmos database response with the created or existing database or an error.

createDatabaseIfNotExists

public Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

Create a Database if it does not already exist on the service. The throughputProperties will only be used if the specified database does not exist and therefor a new database will be created with throughputProperties. The Mono upon successful completion will contain a single cosmos database response with the created or existing database.

Parameters:

id - the id.
throughputProperties - the throughputProperties.

Returns:

the mono.

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

Create global throughput control config builder which will be used to build GlobalThroughputControlConfig.

Parameters:

databaseId - The database id of the control container.
containerId - The container id of the control container.

Returns:

getDatabase

public CosmosAsyncDatabase getDatabase(String id)

Gets a database object without making a service call.

Parameters:

id - name of the database.

Returns:

queryDatabases

public CosmosPagedFlux<CosmosDatabaseProperties> queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

Query for databases. After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response of the read databases. In case of failure the CosmosPagedFlux<T> will error.

Parameters:

querySpec - the SQL query specification.
options - the feed options.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of read databases or an error.

queryDatabases

public CosmosPagedFlux<CosmosDatabaseProperties> queryDatabases(String query, CosmosQueryRequestOptions options)

Query for databases. After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response of the read databases. In case of failure the CosmosPagedFlux<T> will error.

Parameters:

query - the query.
options - the feed options.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of read databases or an error.

readAllDatabases

public CosmosPagedFlux<CosmosDatabaseProperties> readAllDatabases()

Reads all databases. After subscription the operation will be performed. The CosmosPagedFlux<T> will contain one or several feed response of the read databases. In case of failure the CosmosPagedFlux<T> will error.

Returns:

a CosmosPagedFlux<T> containing one or several feed response pages of read databases or an error.

Applies to