CosmosDatabase (Azure SDK for Java Reference Documentation)

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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CosmosContainerResponse`	`createContainer(CosmosContainerProperties containerProperties)` Creates a Cosmos container.
`CosmosContainerResponse`	`createContainer(CosmosContainerProperties containerProperties, CosmosContainerRequestOptions options)` Creates a Cosmos container while passing additional request options.
`CosmosContainerResponse`	`createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)` Creates a Cosmos container with custom throughput setting.
`CosmosContainerResponse`	`createContainer(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties, CosmosContainerRequestOptions options)` Creates a Cosmos container.
`CosmosContainerResponse`	`createContainer(String id, String partitionKeyPath)` Create a Cosmos container.
`CosmosContainerResponse`	`createContainer(String id, String partitionKeyPath, ThroughputProperties throughputProperties)` Create a Cosmos container.
`CosmosContainerResponse`	`createContainerIfNotExists(CosmosContainerProperties containerProperties)` Create container if one matching the id in the properties object does not exist.
`CosmosContainerResponse`	`createContainerIfNotExists(CosmosContainerProperties containerProperties, ThroughputProperties throughputProperties)` Creates a Cosmos container if one matching the id in the properties object does not exist.
`CosmosContainerResponse`	`createContainerIfNotExists(String id, String partitionKeyPath)` Creates a Cosmos container if one matching the id does not exist.
`CosmosContainerResponse`	`createContainerIfNotExists(String id, String partitionKeyPath, ThroughputProperties throughputProperties)` Creates a Cosmos container if one matching the id does not exist.
`CosmosUserResponse`	`createUser(CosmosUserProperties userProperties)` Create Cosmos user instance without making a service call.
`CosmosDatabaseResponse`	`delete()` Deletes the current Cosmos database.
`CosmosDatabaseResponse`	`delete(CosmosDatabaseRequestOptions options)` Delete the current Cosmos database while specifying additional request options.
`CosmosClientEncryptionKey`	`getClientEncryptionKey(String id)` Gets a CosmosClientEncryptionKey object without making a service call
`CosmosContainer`	`getContainer(String id)` Gets a Cosmos container instance without making a service call.
`String`	`getId()` Get the id of the Cosmos database.
`CosmosUser`	`getUser(String id)` Gets a Cosmos user instance without making a service call.
`CosmosPagedIterable<CosmosContainerProperties>`	`queryContainers(SqlQuerySpec querySpec)` Query containers in the current database.
`CosmosPagedIterable<CosmosContainerProperties>`	`queryContainers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)` Query containers in the current database.
`CosmosPagedIterable<CosmosContainerProperties>`	`queryContainers(String query)` Query containers in the current database.
`CosmosPagedIterable<CosmosContainerProperties>`	`queryContainers(String query, CosmosQueryRequestOptions options)` Query containers iterator.
`CosmosPagedIterable<CosmosUserProperties>`	`queryUsers(SqlQuerySpec querySpec)` Query all Cosmos users for the current database.
`CosmosPagedIterable<CosmosUserProperties>`	`queryUsers(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)` Query all Cosmos users for the current database.
`CosmosPagedIterable<CosmosUserProperties>`	`queryUsers(String query)` Query all Cosmos users for the current database.
`CosmosPagedIterable<CosmosUserProperties>`	`queryUsers(String query, CosmosQueryRequestOptions options)` Query all Cosmos users for the current database.
`CosmosDatabaseResponse`	`read()` Reads the current Cosmos database.
`CosmosDatabaseResponse`	`read(CosmosDatabaseRequestOptions options)` Reads the current Cosmos database while specifying additional request options.
`CosmosPagedIterable<CosmosClientEncryptionKeyProperties>`	`readAllClientEncryptionKeys()` Reads all cosmos client encryption keys in a database.
`CosmosPagedIterable<CosmosContainerProperties>`	`readAllContainers()` Read all containers in the current database.
`CosmosPagedIterable<CosmosUserProperties>`	`readAllUsers()` Read all Cosmos users for the current database.
`ThroughputResponse`	`readThroughput()` Gets the throughput of the database.
`ThroughputResponse`	`replaceThroughput(ThroughputProperties throughputProperties)` Sets the throughput.
`CosmosUserResponse`	`upsertUser(CosmosUserProperties userProperties)` Upserts a Cosmos user.

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 Cosmos database.
    
    Returns:
    
    the id of the database.
  - read
```
public CosmosDatabaseResponse read()
```
    Reads the current Cosmos database.
    
    Returns:
    
    the CosmosDatabaseResponse.
  - read
```
public CosmosDatabaseResponse read(CosmosDatabaseRequestOptions options)
```
    Reads the current Cosmos database while specifying additional request options.
    
    Parameters:
    
    options - the CosmosDatabaseRequestOptions request options.
    
    Returns:
    
    the CosmosDatabaseResponse
  - delete
```
public CosmosDatabaseResponse delete()
```
    Deletes the current Cosmos database.
    
    Returns:
    
    the CosmosDatabaseResponse.
  - delete
```
public CosmosDatabaseResponse delete(CosmosDatabaseRequestOptions options)
```
    Delete the current Cosmos database while specifying additional request options.
    
    Parameters:
    
    options - the CosmosDatabaseRequestOptions request options.
    
    Returns:
    
    the CosmosDatabaseResponse.
  - createContainer
```
public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties)
```
    Creates a Cosmos container.
    
    Parameters:
    
    containerProperties - the CosmosContainerProperties.
    
    Returns:
    
    the CosmosContainerResponse with the created container.
  - createContainer
```
public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               ThroughputProperties throughputProperties)
```
    Creates a Cosmos container with custom throughput setting.
    
    Parameters:
    
    containerProperties - the CosmosContainerProperties.
    
    throughputProperties - the throughput properties.
    
    Returns:
    
    the CosmosContainerResponse with the created container.
  - createContainer
```
public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               CosmosContainerRequestOptions options)
```
    Creates a Cosmos container while passing additional request options.
    
    Parameters:
    
    containerProperties - the CosmosContainerProperties.
    
    options - the CosmosContainerProperties.
    
    Returns:
    
    the CosmosContainerResponse with the created container.
  - createContainer
```
public CosmosContainerResponse createContainer(CosmosContainerProperties containerProperties,
                                               ThroughputProperties throughputProperties,
                                               CosmosContainerRequestOptions options)
```
    Creates a Cosmos container.
    
    Parameters:
    
    containerProperties - the container properties.
    
    throughputProperties - the throughput properties.
    
    options - the options.
    
    Returns:
    
    the cosmos container response.
  - createContainer
```
public CosmosContainerResponse createContainer(String id,
                                               String partitionKeyPath)
```
    Create a Cosmos container.
    
    Parameters:
    
    id - the container id.
    
    partitionKeyPath - the partition key path.
    
    Returns:
    
    the cosmos container response.
  - createContainer
```
public CosmosContainerResponse createContainer(String id,
                                               String partitionKeyPath,
                                               ThroughputProperties throughputProperties)
```
    Create a Cosmos container.
    
    Parameters:
    
    id - the id.
    
    partitionKeyPath - the partition key path.
    
    throughputProperties - the throughput properties.
    
    Returns:
    
    the cosmos container response.
  - createContainerIfNotExists
```
public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties)
```
    Create container if one matching the id in the properties object does not exist.
    
    Parameters:
    
    containerProperties - the container properties.
    
    Returns:
    
    the cosmos container response.
  - createContainerIfNotExists
```
public CosmosContainerResponse createContainerIfNotExists(CosmosContainerProperties containerProperties,
                                                          ThroughputProperties throughputProperties)
```
    Creates a Cosmos container if one matching the id in the properties object does not exist.
    The throughput properties will only be used if the specified container does not exist and therefor a new container will be created.
    
    Parameters:
    
    containerProperties - the container properties.
    
    throughputProperties - the throughput properties for the container.
    
    Returns:
    
    the cosmos container response.
  - createContainerIfNotExists
```
public CosmosContainerResponse createContainerIfNotExists(String id,
                                                          String partitionKeyPath)
```
    Creates a Cosmos container if one matching the id does not exist.
    
    Parameters:
    
    id - the id.
    
    partitionKeyPath - the partition key path.
    
    Returns:
    
    the cosmos container response.
  - createContainerIfNotExists
```
public CosmosContainerResponse createContainerIfNotExists(String id,
                                                          String partitionKeyPath,
                                                          ThroughputProperties throughputProperties)
```
    Creates a Cosmos container if one matching the id does not exist.
    The throughput properties will only be used if the specified container does not exist and therefor a new container will be created.
    
    Parameters:
    
    id - the id.
    
    partitionKeyPath - the partition key path.
    
    throughputProperties - the throughput properties for the container.
    
    Returns:
    
    the cosmos container response.
  - readAllContainers
```
public CosmosPagedIterable<CosmosContainerProperties> readAllContainers()
```
    Read all containers in the current database.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryContainers
```
public CosmosPagedIterable<CosmosContainerProperties> queryContainers(String query)
```
    Query containers in the current database.
    
    Parameters:
    
    query - the query.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryContainers
```
public CosmosPagedIterable<CosmosContainerProperties> queryContainers(String query,
                                                                      CosmosQueryRequestOptions options)
```
    Query containers iterator.
    
    Parameters:
    
    query - the query.
    
    options - the options.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryContainers
```
public CosmosPagedIterable<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec)
```
    Query containers in the current database.
    
    Parameters:
    
    querySpec - the query spec.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryContainers
```
public CosmosPagedIterable<CosmosContainerProperties> queryContainers(SqlQuerySpec querySpec,
                                                                      CosmosQueryRequestOptions options)
```
    Query containers in the current database.
    
    Parameters:
    
    querySpec - the query spec.
    
    options - the options.
    
    Returns:
    
    the CosmosPagedIterable.
  - getContainer
```
public CosmosContainer getContainer(String id)
```
    Gets a Cosmos container instance without making a service call.
    To get the actual object a read operation must be performed first.
    
    Parameters:
    
    id - id of the container.
    
    Returns:
    
    Cosmos Container.
  - createUser
```
public CosmosUserResponse createUser(CosmosUserProperties userProperties)
```
    Create Cosmos user instance without making a service call.
    To get the actual object a read operation must be performed first.
    
    Parameters:
    
    userProperties - the settings.
    
    Returns:
    
    the cosmos user response.
  - upsertUser
```
public CosmosUserResponse upsertUser(CosmosUserProperties userProperties)
```
    Upserts a Cosmos user.
    
    Parameters:
    
    userProperties - the settings.
    
    Returns:
    
    the cosmos user response.
  - readAllUsers
```
public CosmosPagedIterable<CosmosUserProperties> readAllUsers()
```
    Read all Cosmos users for the current database.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryUsers
```
public CosmosPagedIterable<CosmosUserProperties> queryUsers(String query)
```
    Query all Cosmos users for the current database.
    
    Parameters:
    
    query - the query.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryUsers
```
public CosmosPagedIterable<CosmosUserProperties> queryUsers(String query,
                                                            CosmosQueryRequestOptions options)
```
    Query all Cosmos users for the current database.
    
    Parameters:
    
    query - the query.
    
    options - the options.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryUsers
```
public CosmosPagedIterable<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec)
```
    Query all Cosmos users for the current database.
    
    Parameters:
    
    querySpec - the query spec.
    
    Returns:
    
    the CosmosPagedIterable.
  - queryUsers
```
public CosmosPagedIterable<CosmosUserProperties> queryUsers(SqlQuerySpec querySpec,
                                                            CosmosQueryRequestOptions options)
```
    Query all Cosmos users for the current database.
    
    Parameters:
    
    querySpec - the query spec.
    
    options - the options.
    
    Returns:
    
    the CosmosPagedIterable.
  - getUser
```
public CosmosUser getUser(String id)
```
    Gets a Cosmos user instance without making a service call.
    To get the actual object a read operation must be performed first.
    
    Parameters:
    
    id - the id.
    
    Returns:
    
    the user.
  - replaceThroughput
```
public ThroughputResponse replaceThroughput(ThroughputProperties throughputProperties)
```
    Sets the throughput.
    
    Parameters:
    
    throughputProperties - the throughput properties.
    
    Returns:
    
    the throughput response.
  - readThroughput
```
public ThroughputResponse readThroughput()
```
    Gets the throughput of the database.
    
    Returns:
    
    the throughput response.
  - getClientEncryptionKey
```
@Beta(value=V4_15_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosClientEncryptionKey getClientEncryptionKey(String id)
```
    Gets a CosmosClientEncryptionKey object without making a service call
    
    Parameters:
    
    id - id of the clientEncryptionKey
    
    Returns:
    
    Cosmos ClientEncryptionKey
  - readAllClientEncryptionKeys
```
@Beta(value=V4_15_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosPagedIterable<CosmosClientEncryptionKeyProperties> readAllClientEncryptionKeys()
```
    Reads all cosmos client encryption keys in a database.
    
    Returns:
    
    a CosmosPagedIterable.

Class CosmosDatabase

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getId

read

read

delete

delete

createContainer

createContainer

createContainer

createContainer

createContainer

createContainer

createContainerIfNotExists

createContainerIfNotExists

createContainerIfNotExists

createContainerIfNotExists

readAllContainers

queryContainers

queryContainers

queryContainers

queryContainers

getContainer

createUser

upsertUser

readAllUsers

queryUsers

queryUsers

queryUsers

queryUsers

getUser

replaceThroughput

readThroughput

getClientEncryptionKey

readAllClientEncryptionKeys