com.azure.cosmos.CosmosAsyncDatabase Maven / Gradle / Ivy
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.azure.cosmos;
import com.azure.cosmos.implementation.AsyncDocumentClient;
import com.azure.cosmos.implementation.HttpConstants;
import com.azure.cosmos.implementation.Offer;
import com.azure.cosmos.implementation.Paths;
import org.apache.commons.lang3.StringUtils;
import reactor.core.Exceptions;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import static com.azure.cosmos.Resource.validateResource;
/**
* Perform read and delete databases, update database throughput, and perform operations on child resources
*/
public class CosmosAsyncDatabase {
private final CosmosAsyncClient client;
private final String id;
private final String link;
CosmosAsyncDatabase(String id, CosmosAsyncClient client) {
this.id = id;
this.client = client;
this.link = getParentLink() + "/" + getURIPathSegment() + "/" + getId();
}
/**
* Get the id of the CosmosAsyncDatabase
*
* @return the id of the CosmosAsyncDatabase
*/
public String getId() {
return id;
}
/**
* Reads a database.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a single cosmos database respone with the
* read database. In case of failure the {@link Mono} will error.
*
* @return an {@link Mono} containing the single cosmos database respone with
* the read database or an error.
*/
public Mono read() {
return read(new CosmosDatabaseRequestOptions());
}
/**
* Reads a database.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos cosmos database respone with the
* read database. In case of failure the {@link Mono} will error.
*
* @param options the request options.
* @return an {@link Mono} containing the single cosmos database response with
* the read database or an error.
*/
public Mono read(CosmosDatabaseRequestOptions options) {
if (options == null) {
options = new CosmosDatabaseRequestOptions();
}
return getDocClientWrapper().readDatabase(getLink(), options.toRequestOptions())
.map(response -> new CosmosAsyncDatabaseResponse(response, getClient())).single();
}
/**
* Deletes a database.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos database response with the
* deleted database. In case of failure the {@link Mono} will error.
*
* @return an {@link Mono} containing the single cosmos database response
*/
public Mono delete() {
return delete(new CosmosDatabaseRequestOptions());
}
/**
* Deletes a database.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos database response with the
* deleted database. In case of failure the {@link Mono} will error.
*
* @param options the request options
* @return an {@link Mono} containing the single cosmos database response
*/
public Mono delete(CosmosDatabaseRequestOptions options) {
if (options == null) {
options = new CosmosDatabaseRequestOptions();
}
return getDocClientWrapper().deleteDatabase(getLink(), options.toRequestOptions())
.map(response -> new CosmosAsyncDatabaseResponse(response, getClient())).single();
}
/* CosmosAsyncContainer operations */
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param containerProperties the container properties.
* @return a {@link Flux} containing the single cosmos container response with
* the created container or an error.
* @throws IllegalArgumentException containerProperties cannot be null
*/
public Mono createContainer(CosmosContainerProperties containerProperties) {
return createContainer(containerProperties, new CosmosContainerRequestOptions());
}
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param containerProperties the container properties.
* @param throughput the throughput for the container
* @return a {@link Flux} containing the single cosmos container response with
* the created container or an error.
* @throws IllegalArgumentException thown if containerProerties are null
*/
public Mono createContainer(CosmosContainerProperties containerProperties,
int throughput) {
if (containerProperties == null) {
throw new IllegalArgumentException("containerProperties");
}
validateResource(containerProperties);
CosmosContainerRequestOptions options = new CosmosContainerRequestOptions();
options.setOfferThroughput(throughput);
return createContainer(containerProperties, options);
}
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param containerProperties the containerProperties.
* @param options the cosmos container request options
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
* @throws IllegalArgumentException containerProperties can not be null
*/
public Mono createContainer(CosmosContainerProperties containerProperties,
CosmosContainerRequestOptions options) {
if (containerProperties == null) {
throw new IllegalArgumentException("containerProperties");
}
validateResource(containerProperties);
if (options == null) {
options = new CosmosContainerRequestOptions();
}
return getDocClientWrapper()
.createCollection(this.getLink(), containerProperties.getV2Collection(), options.toRequestOptions())
.map(response -> new CosmosAsyncContainerResponse(response, this)).single();
}
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param containerProperties the containerProperties.
* @param throughput the throughput for the container
* @param options the cosmos container request options
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
* @throws IllegalArgumentException containerProperties cannot be null
*/
public Mono createContainer(CosmosContainerProperties containerProperties,
int throughput,
CosmosContainerRequestOptions options) {
if (options == null) {
options = new CosmosContainerRequestOptions();
}
options.setOfferThroughput(throughput);
return createContainer(containerProperties, options);
}
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param id the cosmos container id
* @param partitionKeyPath the partition key path
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
*/
public Mono createContainer(String id, String partitionKeyPath) {
return createContainer(new CosmosContainerProperties(id, partitionKeyPath));
}
/**
* Creates a document container.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param id the cosmos container id
* @param partitionKeyPath the partition key path
* @param throughput the throughput for the container
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
*/
public Mono createContainer(String id, String partitionKeyPath, int throughput) {
CosmosContainerRequestOptions options = new CosmosContainerRequestOptions();
options.setOfferThroughput(throughput);
return createContainer(new CosmosContainerProperties(id, partitionKeyPath), options);
}
/**
* Creates a document container if it does not exist on the service.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created or existing container. In case of failure the {@link Mono} will
* error.
*
* @param containerProperties the container properties
* @return a {@link Mono} containing the cosmos container response with the
* created or existing container or an error.
*/
public Mono createContainerIfNotExists(
CosmosContainerProperties containerProperties) {
CosmosAsyncContainer container = getContainer(containerProperties.getId());
return createContainerIfNotExistsInternal(containerProperties, container, null);
}
/**
* Creates a document container if it does not exist on the service.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created or existing container. In case of failure the {@link Mono} will
* error.
*
* @param containerProperties the container properties
* @param throughput the throughput for the container
* @return a {@link Mono} containing the cosmos container response with the
* created or existing container or an error.
*/
public Mono createContainerIfNotExists(CosmosContainerProperties containerProperties,
int throughput) {
CosmosContainerRequestOptions options = new CosmosContainerRequestOptions();
options.setOfferThroughput(throughput);
CosmosAsyncContainer container = getContainer(containerProperties.getId());
return createContainerIfNotExistsInternal(containerProperties, container, options);
}
/**
* Creates a document container if it does not exist on the service.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param id the cosmos container id
* @param partitionKeyPath the partition key path
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
*/
public Mono createContainerIfNotExists(String id, String partitionKeyPath) {
CosmosAsyncContainer container = getContainer(id);
return createContainerIfNotExistsInternal(new CosmosContainerProperties(id, partitionKeyPath),
container,
null);
}
/**
* Creates a document container if it does not exist on the service.
*
* After subscription the operation will be performed. The {@link Mono} upon
* successful completion will contain a cosmos container response with the
* created container. In case of failure the {@link Mono} will error.
*
* @param id the cosmos container id
* @param partitionKeyPath the partition key path
* @param throughput the throughput for the container
* @return a {@link Flux} containing the cosmos container response with the
* created container or an error.
*/
public Mono createContainerIfNotExists(String id, String partitionKeyPath,
int throughput) {
CosmosContainerRequestOptions options = new CosmosContainerRequestOptions();
options.setOfferThroughput(throughput);
CosmosAsyncContainer container = getContainer(id);
return createContainerIfNotExistsInternal(new CosmosContainerProperties(id, partitionKeyPath), container,
options);
}
private Mono createContainerIfNotExistsInternal(
CosmosContainerProperties containerProperties, CosmosAsyncContainer container,
CosmosContainerRequestOptions options) {
return container.read(options).onErrorResume(exception -> {
final Throwable unwrappedException = Exceptions.unwrap(exception);
if (unwrappedException instanceof CosmosClientException) {
final CosmosClientException cosmosClientException = (CosmosClientException) unwrappedException;
if (cosmosClientException.getStatusCode() == HttpConstants.StatusCodes.NOTFOUND) {
return createContainer(containerProperties, options);
}
}
return Mono.error(unwrappedException);
});
}
/**
* Reads all cosmos containers.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the read containers. In case of
* failure the {@link Flux} will error.
*
* @param options {@link FeedOptions}
* @return a {@link Flux} containing one or several feed response pages of read
* containers or an error.
*/
public Flux> readAllContainers(FeedOptions options) {
return getDocClientWrapper().readCollections(getLink(), options)
.map(response -> BridgeInternal.createFeedResponse(
CosmosContainerProperties.getFromV2Results(response.getResults()),
response.getResponseHeaders()));
}
/**
* Reads all cosmos containers.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the read containers. In case of
* failure the {@link Flux} will error.
*
* @return a {@link Flux} containing one or several feed response pages of read
* containers or an error.
*/
public Flux> readAllContainers() {
return readAllContainers(new FeedOptions());
}
/**
* Query for cosmos containers in a cosmos database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained containers. In case of
* failure the {@link Flux} will error.
*
* @param query the query
* @return a {@link Flux} containing one or several feed response pages of the
* obtained containers or an error.
*/
public Flux> queryContainers(String query) {
return queryContainers(new SqlQuerySpec(query));
}
/**
* Query for cosmos containers in a cosmos database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained containers. In case of
* failure the {@link Flux} will error.
*
* @param query the query.
* @param options the feed options.
* @return a {@link Flux} containing one or several feed response pages of the
* obtained containers or an error.
*/
public Flux> queryContainers(String query, FeedOptions options) {
return queryContainers(new SqlQuerySpec(query), options);
}
/**
* Query for cosmos containers in a cosmos database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained containers. In case of
* failure the {@link Flux} will error.
*
* @param querySpec the SQL query specification.
* @return a {@link Flux} containing one or several feed response pages of the
* obtained containers or an error.
*/
public Flux> queryContainers(SqlQuerySpec querySpec) {
return queryContainers(querySpec, null);
}
/**
* Query for cosmos containers in a cosmos database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained containers. In case of
* failure the {@link Flux} will error.
*
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return a {@link Flux} containing one or several feed response pages of the
* obtained containers or an error.
*/
public Flux> queryContainers(SqlQuerySpec querySpec, FeedOptions options) {
return getDocClientWrapper().queryCollections(getLink(), querySpec, options)
.map(response -> BridgeInternal.createFeedResponse(
CosmosContainerProperties.getFromV2Results(response.getResults()),
response.getResponseHeaders()));
}
/**
* Gets a CosmosAsyncContainer object without making a service call
*
* @param id id of the container
* @return Cosmos Container
*/
public CosmosAsyncContainer getContainer(String id) {
return new CosmosAsyncContainer(id, this);
}
/** User operations **/
/**
* Creates a user After subscription the operation will be performed. The
* {@link Mono} upon successful completion will contain a single resource
* response with the created user. In case of failure the {@link Mono} will
* error.
*
* @param settings the cosmos user properties
* @return an {@link Mono} containing the single resource response with the
* created cosmos user or an error.
*/
public Mono createUser(CosmosUserProperties settings) {
return getDocClientWrapper().createUser(this.getLink(), settings.getV2User(), null)
.map(response -> new CosmosAsyncUserResponse(response, this)).single();
}
/**
* 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 {@link Mono} upon successful completion will contain a single
* resource response with the created user. In case of failure the {@link Mono}
* will error.
*
* @param settings the cosmos user properties
* @return an {@link Mono} containing the single resource response with the
* upserted user or an error.
*/
public Mono upsertUser(CosmosUserProperties settings) {
return getDocClientWrapper().upsertUser(this.getLink(), settings.getV2User(), null)
.map(response -> new CosmosAsyncUserResponse(response, this)).single();
}
/**
* Reads all cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the read cosmos users. In case of
* failure the {@link Flux} will error.
*
* @return a {@link Flux} containing one or several feed response pages of the
* read cosmos users or an error.
*/
public Flux> readAllUsers() {
return readAllUsers(new FeedOptions());
}
/**
* Reads all cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the read cosmos users. In case of
* failure the {@link Flux} will error.
*
* @param options the feed options.
* @return a {@link Flux} containing one or several feed response pages of the
* read cosmos users or an error.
*/
public Flux> readAllUsers(FeedOptions options) {
return getDocClientWrapper().readUsers(getLink(), options).map(response -> BridgeInternal.createFeedResponse(
CosmosUserProperties.getFromV2Results(response.getResults()), response.getResponseHeaders()));
}
/**
* Query for cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained users. In case of
* failure the {@link Flux} will error.
*
* @param query query as string
* @return a {@link Flux} containing one or several feed response pages of the
* obtained users or an error.
*/
public Flux> queryUsers(String query) {
return queryUsers(query, null);
}
/**
* Query for cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained users. In case of
* failure the {@link Flux} will error.
*
* @param query query as string
* @param options the feed options
* @return a {@link Flux} containing one or several feed response pages of the
* obtained users or an error.
*/
public Flux> queryUsers(String query, FeedOptions options) {
return queryUsers(new SqlQuerySpec(query), options);
}
/**
* Query for cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained users. In case of
* failure the {@link Flux} will error.
*
* @param querySpec the SQL query specification.
* @return a {@link Flux} containing one or several feed response pages of the
* obtained users or an error.
*/
public Flux> queryUsers(SqlQuerySpec querySpec) {
return queryUsers(querySpec, null);
}
/**
* Query for cosmos users in a database.
*
* After subscription the operation will be performed. The {@link Flux} will
* contain one or several feed response of the obtained users. In case of
* failure the {@link Flux} will error.
*
* @param querySpec the SQL query specification.
* @param options the feed options.
* @return a {@link Flux} containing one or several feed response pages of the
* obtained users or an error.
*/
public Flux> queryUsers(SqlQuerySpec querySpec, FeedOptions options) {
return getDocClientWrapper().queryUsers(getLink(), querySpec, options)
.map(response -> BridgeInternal.createFeedResponseWithQueryMetrics(
CosmosUserProperties.getFromV2Results(response.getResults()), response.getResponseHeaders(),
response.queryMetrics()));
}
public CosmosAsyncUser getUser(String id) {
return new CosmosAsyncUser(id, this);
}
/**
* Gets the throughput of the database
*
* @return a {@link Mono} containing throughput or an error.
*/
public Mono readProvisionedThroughput() {
return this.read()
.flatMap(cosmosDatabaseResponse -> getDocClientWrapper()
.queryOffers("select * from c where c.offerResourceId = '"
+ cosmosDatabaseResponse
.getProperties()
.getResourceId() + "'", new FeedOptions())
.single()
.flatMap(offerFeedResponse -> {
if (offerFeedResponse.getResults().isEmpty()) {
return Mono.error(BridgeInternal.createCosmosClientException(
HttpConstants.StatusCodes.BADREQUEST,
"No offers found for the resource"));
}
return getDocClientWrapper().readOffer(offerFeedResponse.getResults()
.get(0)
.getSelfLink())
.single();
}).map(cosmosContainerResponse1 -> cosmosContainerResponse1.getResource()
.getThroughput()));
}
/**
* Sets throughput provisioned for a container in measurement of
* Requests-per-Unit in the Azure Cosmos service.
*
* @param requestUnitsPerSecond the cosmos container throughput, expressed in
* Request Units per second
* @return a {@link Mono} containing throughput or an error.
*/
public Mono replaceProvisionedThroughput(int requestUnitsPerSecond) {
return this.read()
.flatMap(cosmosDatabaseResponse -> this.getDocClientWrapper()
.queryOffers("select * from c where c.offerResourceId = '"
+ cosmosDatabaseResponse.getProperties().getResourceId()
+ "'", new FeedOptions())
.single()
.flatMap(offerFeedResponse -> {
if (offerFeedResponse.getResults().isEmpty()) {
return Mono.error(BridgeInternal.createCosmosClientException(
HttpConstants.StatusCodes.BADREQUEST,
"No offers found for the resource"));
}
Offer offer = offerFeedResponse.getResults().get(0);
offer.setThroughput(requestUnitsPerSecond);
return this.getDocClientWrapper().replaceOffer(offer).single();
}).map(offerResourceResponse -> offerResourceResponse.getResource()
.getThroughput()));
}
CosmosAsyncClient getClient() {
return client;
}
AsyncDocumentClient getDocClientWrapper() {
return client.getDocClientWrapper();
}
String getURIPathSegment() {
return Paths.DATABASES_PATH_SEGMENT;
}
String getParentLink() {
return StringUtils.EMPTY;
}
String getLink() {
return this.link;
}
}