com.microsoft.azure.cosmos

Class CosmosClient

java.lang.Object

com.microsoft.azure.cosmos.CosmosClient

public class CosmosClient
extends Object

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

Method Summary

Modifier and Type	Method and Description
void	close() Close this CosmosClient instance and cleans up the resources.
static CosmosClient	create(CosmosConfiguration cosmosConfiguration) Creates a cosmos client with given cosmosConfiguration
static CosmosClient	create(String endpoint, String key) Creates a cosmos client with given endpoint and key
reactor.core.publisher.Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseSettings databaseSettings) Creates a database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseSettings databaseSettings, CosmosDatabaseRequestOptions options) Creates a database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	createDatabase(String id) Creates a database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(CosmosDatabaseSettings databaseSettings) 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.
reactor.core.publisher.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.
CosmosDatabase	getDatabase(String id) Gets a database object without making a service call.
reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>>	listDatabases() Reads all databases.
reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>>	listDatabases(FeedOptions options) Reads all databases.
reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>>	queryDatabases(SqlQuerySpec querySpec, FeedOptions options) Query for databases.
reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>>	queryDatabases(String query, FeedOptions options) Query for databases.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CosmosClient create(CosmosConfiguration cosmosConfiguration)

Creates a cosmos client with given cosmosConfiguration

Parameters:

cosmosConfiguration - the cosmosConfiguration

Returns:

cosmos client

create

public static CosmosClient create(String endpoint,
                                  String key)

Creates a cosmos client with given endpoint and key

Parameters:

endpoint - the service end point

key - the key

Returns:

cosmos clients

createDatabaseIfNotExists

public reactor.core.publisher.Mono<CosmosDatabaseResponse> createDatabaseIfNotExists(CosmosDatabaseSettings databaseSettings)

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:

databaseSettings - CosmosDatabaseSettings

Returns:

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

createDatabaseIfNotExists

public reactor.core.publisher.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

createDatabase

public reactor.core.publisher.Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseSettings databaseSettings,
                                                                          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:

databaseSettings - CosmosDatabaseSettings

options - CosmosDatabaseRequestOptions

Returns:

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

createDatabase

public reactor.core.publisher.Mono<CosmosDatabaseResponse> createDatabase(CosmosDatabaseSettings databaseSettings)

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:

databaseSettings - CosmosDatabaseSettings

Returns:

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

createDatabase

public reactor.core.publisher.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.

listDatabases

public reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>> listDatabases(FeedOptions options)

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

Parameters:

options - FeedOptions

Returns:

a Flux containing one or several feed response pages of read databases or an error.

listDatabases

public reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>> listDatabases()

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

Returns:

a Flux containing one or several feed response pages of read databases or an error.

queryDatabases

public reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>> queryDatabases(String query,
                                                                                        FeedOptions options)

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

Parameters:

query - the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of read databases or an error.

queryDatabases

public reactor.core.publisher.Flux<FeedResponse<CosmosDatabaseSettings>> queryDatabases(SqlQuerySpec querySpec,
                                                                                        FeedOptions options)

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

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of read databases or an error.

getDatabase

public CosmosDatabase getDatabase(String id)

Gets a database object without making a service call.

Parameters:

id - name of the database

Returns:

close

public void close()

Close this CosmosClient instance and cleans up the resources.