com.microsoft.azure.cosmos

Class CosmosDatabase

java.lang.Object

com.microsoft.azure.cosmos.CosmosResource

com.microsoft.azure.cosmos.CosmosDatabase

public class CosmosDatabase
extends CosmosResource

Cosmos Database

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<CosmosContainerResponse>	createContainer(CosmosContainerSettings containerSettings) Creates a document container.
reactor.core.publisher.Mono<CosmosContainerResponse>	createContainer(CosmosContainerSettings containerSettings, CosmosContainerRequestOptions options) Creates a document container.
reactor.core.publisher.Mono<CosmosContainerResponse>	createContainer(String id, String partitionKeyPath) Creates a document container.
reactor.core.publisher.Mono<CosmosContainerResponse>	createContainerIfNotExists(CosmosContainerSettings containerSettings) Creates a document container if it does not exist on the service.
reactor.core.publisher.Mono<CosmosContainerResponse>	createContainerIfNotExists(String id, String partitionKeyPath) Creates a document container if it does not exist on the service.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	delete() Deletes a database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	delete(CosmosRequestOptions options) Deletes a database.
CosmosContainer	getContainer(String id) Gets a CosmosContainer object without making a service call
protected String	getParentLink()
protected String	getURIPathSegment()
reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>>	listContainers() Reads all cosmos containers.
reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>>	listContainers(FeedOptions options) Reads all cosmos containers.
reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>>	queryContainers(SqlQuerySpec querySpec, FeedOptions options) Query for cosmos containers in a cosmos database.
reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>>	queryContainers(String query, FeedOptions options) Query for cosmos containers in a cosmos database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	read() Reads a database.
reactor.core.publisher.Mono<CosmosDatabaseResponse>	read(CosmosDatabaseRequestOptions options) Reads a database.

Methods inherited from class com.microsoft.azure.cosmos.CosmosResource

getId, setId, validateResource

Methods inherited from class java.lang.Object

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

Method Detail

read

public reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.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 reactor.core.publisher.Mono<CosmosDatabaseResponse> delete(CosmosRequestOptions 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.

Returns:

an Mono containing the single cosmos database response

createContainer

public reactor.core.publisher.Mono<CosmosContainerResponse> createContainer(CosmosContainerSettings containerSettings)

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

Parameters:

containerSettings - the container settings.

Returns:

an Flux containing the single cosmos container response with the created container or an error.

createContainer

public reactor.core.publisher.Mono<CosmosContainerResponse> createContainer(CosmosContainerSettings containerSettings,
                                                                            CosmosContainerRequestOptions options)

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

Parameters:

containerSettings - the containerSettings.

options - the cosmos container request options

Returns:

an Flux containing the cosmos container response with the created container or an error.

createContainer

public reactor.core.publisher.Mono<CosmosContainerResponse> createContainer(String id,
                                                                            String partitionKeyPath)

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

Parameters:

id - the cosmos container id

partitionKeyPath - the partition key path

Returns:

an Flux containing the cosmos container response with the created container or an error.

createContainerIfNotExists

public reactor.core.publisher.Mono<CosmosContainerResponse> createContainerIfNotExists(CosmosContainerSettings containerSettings)

Creates a document 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 collection. In case of failure the Mono will error.

Returns:

a Mono containing the cosmos container response with the created or existing container or an error.

createContainerIfNotExists

public reactor.core.publisher.Mono<CosmosContainerResponse> createContainerIfNotExists(String id,
                                                                                       String partitionKeyPath)

Creates a document 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 collection. In case of failure the Mono will error.

Parameters:

id - the cosmos container id

partitionKeyPath - the partition key path

Returns:

an Flux containing the cosmos container response with the created container or an error.

listContainers

public reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>> listContainers(FeedOptions options)

Reads all cosmos containers. After subscription the operation will be performed. The Flux will contain one or several feed response of the read containers. In case of failure the Flux will error.

Parameters:

options - FeedOptions

Returns:

a Flux containing one or several feed response pages of read containers or an error.

listContainers

public reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>> listContainers()

Reads all cosmos containers. After subscription the operation will be performed. The Flux will contain one or several feed response of the read containers. In case of failure the Flux will error.

Returns:

a Flux containing one or several feed response pages of read containers or an error.

queryContainers

public reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>> queryContainers(String query,
                                                                                          FeedOptions options)

Query for cosmos containers in a cosmos database. After subscription the operation will be performed. The Flux will contain one or several feed response of the obtained containers. In case of failure the Flux will error.

Parameters:

query - the query.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained containers or an error.

queryContainers

public reactor.core.publisher.Flux<FeedResponse<CosmosContainerSettings>> queryContainers(SqlQuerySpec querySpec,
                                                                                          FeedOptions options)

Query for cosmos containers in a cosmos database. After subscription the operation will be performed. The Flux will contain one or several feed response of the obtained containers. In case of failure the Flux will error.

Parameters:

querySpec - the SQL query specification.

options - the feed options.

Returns:

an Flux containing one or several feed response pages of the obtained containers or an error.

getContainer

public CosmosContainer getContainer(String id)

Gets a CosmosContainer object without making a service call

Parameters:

id - id of the container

Returns:

Cosmos Container

getURIPathSegment

protected String getURIPathSegment()

Specified by:

getURIPathSegment in class CosmosResource

getParentLink

protected String getParentLink()

Specified by:

getParentLink in class CosmosResource