com.azure.cosmos

Class CosmosClient

java.lang.Object

com.azure.cosmos.CosmosClient

All Implemented Interfaces:

AutoCloseable

public class CosmosClient
extends Object
implements AutoCloseable

Provides a client-side logical representation of the Azure Cosmos database service. SyncClient is used to perform operations in a synchronous way

Method Summary

Modifier and Type	Method and Description
void	close() Close this CosmosClient instance
static CosmosClientBuilder	cosmosClientBuilder() Instantiate the cosmos client builder to build cosmos client
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties) Creates a database.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) Creates a database.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, int throughput) Creates a database.
CosmosDatabaseResponse	createDatabase(CosmosDatabaseProperties databaseProperties, int throughput, CosmosDatabaseRequestOptions options) Creates a database.
CosmosDatabaseResponse	createDatabase(String id) Creates a database.
CosmosDatabaseResponse	createDatabase(String id, int throughput) Creates a database.
CosmosDatabaseResponse	createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties) Create a Database if it does not already exist on the service
CosmosDatabaseResponse	createDatabaseIfNotExists(String id) Create a Database if it does not already exist on the service
CosmosDatabase	getDatabase(String id) Gets the database client
CosmosContinuablePagedIterable<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, FeedOptions options) Query a database
CosmosContinuablePagedIterable<CosmosDatabaseProperties>	queryDatabases(String query, FeedOptions options) Query a database
CosmosContinuablePagedIterable<CosmosDatabaseProperties>	readAllDatabases() Reads all databases.
CosmosContinuablePagedIterable<CosmosDatabaseProperties>	readAllDatabases(FeedOptions options) Reads all databases.

Methods inherited from class java.lang.Object

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

Method Detail

cosmosClientBuilder

public static CosmosClientBuilder cosmosClientBuilder()

Instantiate the cosmos client builder to build cosmos client

Returns:

CosmosClientBuilder

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)
                                                 throws CosmosClientException

Create a Database if it does not already exist on the service

Parameters:

databaseProperties - CosmosDatabaseProperties the database properties

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception.

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)
                                                 throws CosmosClientException

Create a Database if it does not already exist on the service

Parameters:

id - the id of the database

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties,
                                             CosmosDatabaseRequestOptions options)
                                      throws CosmosClientException

Creates a database.

Parameters:

databaseProperties - CosmosDatabaseProperties the database properties.

options - the request options.

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)
                                      throws CosmosClientException

Creates a database.

Parameters:

databaseProperties - CosmosDatabaseProperties the database properties.

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception.

createDatabase

public CosmosDatabaseResponse createDatabase(String id)
                                      throws CosmosClientException

Creates a database.

Parameters:

id - the id of the database

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception.

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties,
                                             int throughput,
                                             CosmosDatabaseRequestOptions options)
                                      throws CosmosClientException

Creates a database.

Parameters:

databaseProperties - CosmosDatabaseProperties the database properties.

throughput - the throughput

options - CosmosDatabaseRequestOptions the request options

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties,
                                             int throughput)
                                      throws CosmosClientException

Creates a database.

Parameters:

databaseProperties - CosmosDatabaseProperties the database properties.

throughput - the throughput

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception

createDatabase

public CosmosDatabaseResponse createDatabase(String id,
                                             int throughput)
                                      throws CosmosClientException

Creates a database.

Parameters:

id - the id of the database

throughput - the throughput

Returns:

the CosmosDatabaseResponse with the created database.

Throws:

CosmosClientException - the cosmos client exception

readAllDatabases

public CosmosContinuablePagedIterable<CosmosDatabaseProperties> readAllDatabases(FeedOptions options)

Reads all databases.

Parameters:

options - FeedOptionsthe feed options.

Returns:

the CosmosContinuablePagedIterable for feed response with the read databases.

readAllDatabases

public CosmosContinuablePagedIterable<CosmosDatabaseProperties> readAllDatabases()

Reads all databases.

Returns:

the CosmosContinuablePagedIterable for feed response with the read databases.

queryDatabases

public CosmosContinuablePagedIterable<CosmosDatabaseProperties> queryDatabases(String query,
                                                                               FeedOptions options)

Query a database

Parameters:

query - the query

options - FeedOptionsthe feed options.

Returns:

the CosmosContinuablePagedIterable for feed response with the obtained databases.

queryDatabases

public CosmosContinuablePagedIterable<CosmosDatabaseProperties> queryDatabases(SqlQuerySpec querySpec,
                                                                               FeedOptions options)

Query a database

Parameters:

querySpec - SqlQuerySpec the query spec

options - the query

Returns:

the CosmosContinuablePagedIterable for feed response with the obtained databases.

getDatabase

public CosmosDatabase getDatabase(String id)

Gets the database client

Parameters:

id - the id of the database

Returns:

CosmosDatabase the cosmos sync database

close

public void close()

Close this CosmosClient instance

Specified by:

close in interface AutoCloseable