Package com.azure.cosmos

Class CosmosAsyncDatabase

  • public class CosmosAsyncDatabase
extends Object
    Perform read and delete databases, update database throughput, and perform operations on child resources

    • Method Detail

      • getId

        public String getId()
        Get the id of the CosmosAsyncDatabase.
        Returns:
        the id of the CosmosAsyncDatabase.

      • read

        public Mono<CosmosDatabaseResponse> read()
        Reads a database.

        After subscription the operation will be performed. The Mono upon successful completion will contain a single cosmos database respone with the read database. In case of failure the Mono will error.

        Returns:
        an Mono containing the single cosmos database respone with the read database or an error.

      • read

        public Mono<CosmosDatabaseResponse> read​(CosmosDatabaseRequestOptions options)
        Reads a database.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos cosmos database respone with the read database. In case of failure the Mono will error.

        Parameters:
        options - the request options.
        Returns:
        an Mono containing the single cosmos database response with the read database or an error.

      • delete

        public Mono<CosmosDatabaseResponse> delete()
        Deletes a database.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos database response with the deleted database. In case of failure the Mono will error.

        Returns:
        an Mono containing the single cosmos database response.

      • delete

        public Mono<CosmosDatabaseResponse> delete​(CosmosDatabaseRequestOptions options)
        Deletes a database.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos database response with the deleted database. In case of failure the Mono will error.

        Parameters:
        options - the request options.
        Returns:
        an Mono containing the single cosmos database response.

      • createContainer

        public Mono<CosmosContainerResponse> createContainer​(CosmosContainerProperties containerProperties)
        Creates a Cosmos container.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        containerProperties - the container properties.
        Returns:
        a Mono containing the single cosmos container response with the created container or an error.
        Throws:
        IllegalArgumentException - containerProperties cannot be null.

      • createContainer

        public Mono<CosmosContainerResponse> createContainer​(CosmosContainerProperties containerProperties,
                                                     ThroughputProperties throughputProperties)
        Creates a Cosmos container with custom throughput properties.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        containerProperties - the container properties.
        throughputProperties - the throughput properties for the container.
        Returns:
        a Mono containing the single cosmos container response with the created container or an error.
        Throws:
        IllegalArgumentException - thown if containerProerties are null.

      • createContainer

        public Mono<CosmosContainerResponse> createContainer​(CosmosContainerProperties containerProperties,
                                                     CosmosContainerRequestOptions options)
        Creates a Cosmos container.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        containerProperties - the containerProperties.
        options - the cosmos container request options.
        Returns:
        a Mono containing the cosmos container response with the created container or an error.
        Throws:
        IllegalArgumentException - containerProperties can not be null.

      • createContainer

        public Mono<CosmosContainerResponse> createContainer​(String id,
                                                     String partitionKeyPath)
        Creates a Cosmos container.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        id - the cosmos container id.
        partitionKeyPath - the partition key path.
        Returns:
        a Mono containing the cosmos container response with the created container or an error.

      • createContainer

        public Mono<CosmosContainerResponse> createContainer​(String id,
                                                     String partitionKeyPath,
                                                     ThroughputProperties throughputProperties)
        Creates a Cosmos container.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        id - the cosmos container id.
        partitionKeyPath - the partition key path.
        throughputProperties - the throughput properties for the container.
        Returns:
        a Mono containing the cosmos container response with the created container or an error.

      • createContainerIfNotExists

        public Mono<CosmosContainerResponse> createContainerIfNotExists​(CosmosContainerProperties containerProperties)
        Creates a Cosmos container if it does not exist on the service.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created or existing container. In case of failure the Mono will error.

        Parameters:
        containerProperties - the container properties
        Returns:
        a Mono containing the cosmos container response with the created or existing container or an error.

      • createContainerIfNotExists

        public Mono<CosmosContainerResponse> createContainerIfNotExists​(CosmosContainerProperties containerProperties,
                                                                ThroughputProperties throughputProperties)
        Creates a Cosmos container if it does not exist on the service.

        The throughput properties will only be used if the specified container does not exist and therefor a new container will be created. After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created or existing container. In case of failure the Mono will error.

        Parameters:
        containerProperties - the container properties.
        throughputProperties - the throughput properties for the container.
        Returns:
        a Mono containing the cosmos container response with the created or existing container or an error.

      • createContainerIfNotExists

        public Mono<CosmosContainerResponse> createContainerIfNotExists​(String id,
                                                                String partitionKeyPath)
        Creates a Cosmos container if it does not exist on the service.

        After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        id - the cosmos container id.
        partitionKeyPath - the partition key path.
        Returns:
        a Mono containing the cosmos container response with the created container or an error.

      • createContainerIfNotExists

        public Mono<CosmosContainerResponse> createContainerIfNotExists​(String id,
                                                                String partitionKeyPath,
                                                                ThroughputProperties throughputProperties)
        Creates a Cosmos container if it does not exist on the service.

        The throughput properties will only be used if the specified container does not exist and therefor a new container will be created. After subscription the operation will be performed. The Mono upon successful completion will contain a cosmos container response with the created container. In case of failure the Mono will error.

        Parameters:
        id - the cosmos container id.
        partitionKeyPath - the partition key path.
        throughputProperties - the throughput properties for the container.
        Returns:
        a Mono containing the cosmos container response with the created container or an error.

      • queryContainers

        public CosmosPagedFlux<CosmosContainerProperties> queryContainers​(String query)
        Query for cosmos containers in a cosmos database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained containers. In case of failure the CosmosPagedFlux will error.

        Parameters:
        query - the query.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained containers or an error.

      • queryContainers

        public CosmosPagedFlux<CosmosContainerProperties> queryContainers​(SqlQuerySpec querySpec)
        Query for cosmos containers in a cosmos database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained containers. In case of failure the CosmosPagedFlux will error.

        Parameters:
        querySpec - the SQL query specification.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained containers or an error.

      • getContainer

        public CosmosAsyncContainer getContainer​(String id)
        Gets a CosmosAsyncContainer object without making a service call
        Parameters:
        id - id of the container
        Returns:
        Cosmos Container

      • createUser

        public Mono<CosmosUserResponse> createUser​(CosmosUserProperties userProperties)
        Creates a user After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created user. In case of failure the Mono will error.
        Parameters:
        userProperties - the cosmos user properties
        Returns:
        an Mono containing the single resource response with the created cosmos user or an error.

      • createClientEncryptionKey

        @Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Mono<CosmosClientEncryptionKeyResponse> createClientEncryptionKey​(CosmosClientEncryptionKeyProperties keyProperties)
        Creates a client encryption key after subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created client encryption key. In case of failure the Mono will error.
        Parameters:
        keyProperties - the cosmos client encryption key properties
        Returns:
        an Mono containing the single resource response with the created cosmos client encryption key or an error.

      • upsertUser

        public Mono<CosmosUserResponse> upsertUser​(CosmosUserProperties userProperties)
        Upsert a user. Upsert will create a new user if it doesn't exist, or replace the existing one if it does. After subscription the operation will be performed. The Mono upon successful completion will contain a single resource response with the created user. In case of failure the Mono will error.
        Parameters:
        userProperties - the cosmos user properties
        Returns:
        an Mono containing the single resource response with the upserted user or an error.

      • readAllUsers

        public CosmosPagedFlux<CosmosUserProperties> readAllUsers()
        Reads all cosmos users in a database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the read cosmos users. In case of failure the CosmosPagedFlux will error.

        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the read cosmos users or an error.

      • getClientEncryptionKey

        @Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosAsyncClientEncryptionKey getClientEncryptionKey​(String id)
        Gets a CosmosAsyncClientEncryptionKey object without making a service call
        Parameters:
        id - id of the clientEncryptionKey
        Returns:
        Cosmos ClientEncryptionKey

      • queryClientEncryptionKeys

        @Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys​(String query)
        Query for cosmos client encryption keys in a database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained client encryption keys. In case of failure the CosmosPagedFlux will error.

        Parameters:
        query - query as string.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained client encryption keys or an error.

      • queryClientEncryptionKeys

        @Beta(value=V4_14_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public CosmosPagedFlux<CosmosClientEncryptionKeyProperties> queryClientEncryptionKeys​(SqlQuerySpec querySpec)
        Query for cosmos client encryption keys in a database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained client encryption keys. In case of failure the CosmosPagedFlux will error.

        Parameters:
        querySpec - the SQL query specification.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained client encryption keys or an error.

      • queryUsers

        public CosmosPagedFlux<CosmosUserProperties> queryUsers​(String query)
        Query for cosmos users in a database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained users. In case of failure the CosmosPagedFlux will error.

        Parameters:
        query - query as string.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained users or an error.

      • queryUsers

        public CosmosPagedFlux<CosmosUserProperties> queryUsers​(SqlQuerySpec querySpec)
        Query for cosmos users in a database.

        After subscription the operation will be performed. The CosmosPagedFlux will contain one or several feed response of the obtained users. In case of failure the CosmosPagedFlux will error.

        Parameters:
        querySpec - the SQL query specification.
        Returns:
        a CosmosPagedFlux containing one or several feed response pages of the obtained users or an error.

      • getUser

        public CosmosAsyncUser getUser​(String id)
        Gets user.
        Parameters:
        id - the id
        Returns:
        the user

      • replaceThroughput

        public Mono<ThroughputResponse> replaceThroughput​(ThroughputProperties throughputProperties)
        Sets throughput provisioned for a container in measurement of Requests-per-Unit in the Azure Cosmos service.
        Parameters:
        throughputProperties - the throughput properties.
        Returns:
        the mono.

      • readThroughput

        public Mono<ThroughputResponse> readThroughput()
        Gets the throughput of the database.
        Returns:
        the mono containing throughput response.