com.azure.cosmos

Class CosmosDatabase

java.lang.Object

com.azure.cosmos.CosmosDatabase

public class CosmosDatabase
extends Object

Perform read and delete databases, update database throughput, and perform operations on child resources in a synchronous way

Method Summary

Modifier and Type	Method and Description
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties) Creates a cosmos container.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options) Creates a cosmos container.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, int throughput) Creates a cosmos container.
CosmosContainerResponse	createContainer(CosmosContainerProperties containerProperties, int throughput, CosmosContainerRequestOptions options) Creates a cosmos container.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath) Create container cosmos sync container response.
CosmosContainerResponse	createContainer(String id, String partitionKeyPath, int throughput) Create container cosmos sync container response.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties) Create container if not exists cosmos sync container response.
CosmosContainerResponse	createContainerIfNotExists(CosmosContainerProperties containerProperties, int throughput) Create container if not exists cosmos sync container response.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath) Create container if not exists cosmos sync container response.
CosmosContainerResponse	createContainerIfNotExists(String id, String partitionKeyPath, int throughput) Create container if not exists cosmos sync container response.
CosmosUserResponse	createUser(CosmosUserProperties settings) Create user cosmos sync user response.
CosmosDatabaseResponse	delete() Delete a database.
CosmosDatabaseResponse	delete(CosmosDatabaseRequestOptions options) Delete a database.
CosmosContainer	getContainer(String id) Gets a CosmosContainer object without making a service call
String	getId() Get the id of the CosmosAsyncDatabase
CosmosUser	getUser(String id) Gets user.
CosmosContinuablePagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec) Query containers iterator.
CosmosContinuablePagedIterable<CosmosContainerProperties>	queryContainers(SqlQuerySpec querySpec, FeedOptions options) Query containers iterator.
CosmosContinuablePagedIterable<CosmosContainerProperties>	queryContainers(String query) Query containers iterator.
CosmosContinuablePagedIterable<CosmosContainerProperties>	queryContainers(String query, FeedOptions options) Query containers iterator.
CosmosContinuablePagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec) Query users CosmosContinuablePagedIterable.
CosmosContinuablePagedIterable<CosmosUserProperties>	queryUsers(SqlQuerySpec querySpec, FeedOptions options) Query users CosmosContinuablePagedIterable.
CosmosContinuablePagedIterable<CosmosUserProperties>	queryUsers(String query) Query users CosmosContinuablePagedIterable.
CosmosContinuablePagedIterable<CosmosUserProperties>	queryUsers(String query, FeedOptions options) Query users CosmosContinuablePagedIterable.
CosmosDatabaseResponse	read() Reads a database
CosmosDatabaseResponse	read(CosmosDatabaseRequestOptions options) Reads a database.
CosmosContinuablePagedIterable<CosmosContainerProperties>	readAllContainers() Read all containers iterator.
CosmosContinuablePagedIterable<CosmosContainerProperties>	readAllContainers(FeedOptions options) Read all containers iterator.
CosmosContinuablePagedIterable<CosmosUserProperties>	readAllUsers() Read all users CosmosContinuablePagedIterable.
CosmosContinuablePagedIterable<CosmosUserProperties>	readAllUsers(FeedOptions options) Read all users CosmosContinuablePagedIterable.
Integer	readProvisionedThroughput() Read provisioned throughput integer.
Integer	replaceProvisionedThroughput(int requestUnitsPerSecond) Replace provisioned throughput integer.
CosmosUserResponse	upsertUser(CosmosUserProperties settings) Upsert user cosmos sync user response.

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Get the id of the CosmosAsyncDatabase

Returns:

the id of the database

read

public CosmosDatabaseResponse read()
                            throws CosmosClientException

Reads a database

Returns:

the CosmosDatabaseResponse

Throws:

CosmosClientException - the cosmos client exception

read

public CosmosDatabaseResponse read(CosmosDatabaseRequestOptions options)
                            throws CosmosClientException

Reads a database.

Parameters:

options - the CosmosDatabaseRequestOptions request options.

Returns:

the CosmosDatabaseResponse

Throws:

CosmosClientException - the cosmos client exception

delete

public CosmosDatabaseResponse delete()
                              throws CosmosClientException

Delete a database.

Returns:

the CosmosDatabaseResponse

Throws:

CosmosClientException - the cosmos client exception

delete

public CosmosDatabaseResponse delete(CosmosDatabaseRequestOptions options)
                              throws CosmosClientException

Delete a database.

Parameters:

options - the CosmosDatabaseRequestOptions request options.

Returns:

the CosmosDatabaseResponse

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties)
                                        throws CosmosClientException

Creates a cosmos container.

Parameters:

containerProperties - the CosmosContainerProperties

Returns:

the CosmosContainerResponse with the created container.

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               int throughput)
                                        throws CosmosClientException

Creates a cosmos container.

Parameters:

containerProperties - the CosmosContainerProperties

throughput - the throughput

Returns:

the CosmosContainerResponse with the created container.

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               CosmosContainerRequestOptions options)
                                        throws CosmosClientException

Creates a cosmos container.

Parameters:

containerProperties - the CosmosContainerProperties

options - the CosmosContainerProperties

Returns:

the CosmosContainerResponse with the created container.

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               int throughput,
                                               CosmosContainerRequestOptions options)
                                        throws CosmosClientException

Creates a cosmos container.

Parameters:

containerProperties - the CosmosContainerProperties

throughput - the throughput

options - the CosmosContainerProperties

Returns:

the CosmosContainerResponse with the created container.

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(String id,
                                               String partitionKeyPath)
                                        throws CosmosClientException

Create container cosmos sync container response.

Parameters:

id - the id

partitionKeyPath - the partition key path

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

createContainer

public CosmosContainerResponse createContainer(String id,
                                               String partitionKeyPath,
                                               int throughput)
                                        throws CosmosClientException

Create container cosmos sync container response.

Parameters:

id - the id

partitionKeyPath - the partition key path

throughput - the throughput

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties)
                                                   throws CosmosClientException

Create container if not exists cosmos sync container response.

Parameters:

containerProperties - the container properties

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties,
                                                          int throughput)
                                                   throws CosmosClientException

Create container if not exists cosmos sync container response.

Parameters:

containerProperties - the container properties

throughput - the throughput

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id,
                                                          String partitionKeyPath)
                                                   throws CosmosClientException

Create container if not exists cosmos sync container response.

Parameters:

id - the id

partitionKeyPath - the partition key path

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

createContainerIfNotExists

public CosmosContainerResponse createContainerIfNotExists(String id,
                                                          String partitionKeyPath,
                                                          int throughput)
                                                   throws CosmosClientException

Create container if not exists cosmos sync container response.

Parameters:

id - the id

partitionKeyPath - the partition key path

throughput - the throughput

Returns:

the cosmos sync container response

Throws:

CosmosClientException - the cosmos client exception

readAllContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> readAllContainers(FeedOptions options)

Read all containers iterator.

Parameters:

options - the options

Returns:

the CosmosContinuablePagedIterable

readAllContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> readAllContainers()

Read all containers iterator.

Returns:

the CosmosContinuablePagedIterable

queryContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> queryContainers(String query)

Query containers iterator.

Parameters:

query - the query

Returns:

the CosmosContinuablePagedIterable

queryContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> queryContainers(String query,
                                                                                 FeedOptions options)

Query containers iterator.

Parameters:

query - the query

options - the options

Returns:

the CosmosContinuablePagedIterable

queryContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec)

Query containers iterator.

Parameters:

querySpec - the query spec

Returns:

the CosmosContinuablePagedIterable

queryContainers

public CosmosContinuablePagedIterable<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec,
                                                                                 FeedOptions options)

Query containers iterator.

Parameters:

querySpec - the query spec

options - the options

Returns:

the CosmosContinuablePagedIterable

getContainer

public CosmosContainer getContainer(String id)

Gets a CosmosContainer object without making a service call

Parameters:

id - id of the container

Returns:

Cosmos Container

createUser

public CosmosUserResponse createUser(CosmosUserProperties settings)
                              throws CosmosClientException

Create user cosmos sync user response.

Parameters:

settings - the settings

Returns:

the cosmos sync user response

Throws:

CosmosClientException - the cosmos client exception

upsertUser

public CosmosUserResponse upsertUser(CosmosUserProperties settings)
                              throws CosmosClientException

Upsert user cosmos sync user response.

Parameters:

settings - the settings

Returns:

the cosmos sync user response

Throws:

CosmosClientException - the cosmos client exception

readAllUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> readAllUsers()

Read all users CosmosContinuablePagedIterable.

Returns:

the CosmosContinuablePagedIterable

readAllUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> readAllUsers(FeedOptions options)

Read all users CosmosContinuablePagedIterable.

Parameters:

options - the options

Returns:

the CosmosContinuablePagedIterable

queryUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> queryUsers(String query)

Query users CosmosContinuablePagedIterable.

Parameters:

query - the query

Returns:

the CosmosContinuablePagedIterable

queryUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> queryUsers(String query,
                                                                       FeedOptions options)

Query users CosmosContinuablePagedIterable.

Parameters:

query - the query

options - the options

Returns:

the CosmosContinuablePagedIterable

queryUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec)

Query users CosmosContinuablePagedIterable.

Parameters:

querySpec - the query spec

Returns:

the CosmosContinuablePagedIterable

queryUsers

public CosmosContinuablePagedIterable<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec,
                                                                       FeedOptions options)

Query users CosmosContinuablePagedIterable.

Parameters:

querySpec - the query spec

options - the options

Returns:

the CosmosContinuablePagedIterable

getUser

public CosmosUser getUser(String id)

Gets user.

Parameters:

id - the id

Returns:

the user

readProvisionedThroughput

public Integer readProvisionedThroughput()
                                  throws CosmosClientException

Read provisioned throughput integer.

Returns:

the integer. null response indicates database doesn't have any provisioned RUs

Throws:

CosmosClientException - the cosmos client exception

replaceProvisionedThroughput

public Integer replaceProvisionedThroughput(int requestUnitsPerSecond)
                                     throws CosmosClientException

Replace provisioned throughput integer.

Parameters:

requestUnitsPerSecond - the request units per second

Returns:

the integer

Throws:

CosmosClientException - the cosmos client exception