Database Class

Package:

com.microsoft.azure.documentdb

Maven Artifact:

com.microsoft.azure:azure-documentdb:2.4.7

• java.lang.Object
• • com.microsoft.azure.documentdb.JsonSerializable
  • • com.microsoft.azure.documentdb.Resource
    • • com.microsoft.azure.documentdb.Database

public final class Database
extends Resource

Represents a Database in the Azure Cosmos DB database service. A database manages users, permissions and a set of collections

Each Azure Cosmos DB Service is able to support multiple independent named databases, with the database being the logical container for data. Each Database consists of one or more collections, each of which in turn contain one or more documents. Since databases are an an administrative resource and the Service Master Key will be required in order to access and successfully complete any action using the User APIs.

Constructor Summary

Constructor	Description
Database()	Initialize a database object.
Database(String jsonString)	Initialize a database object from json string.
Database(JSONObject jsonObject)	Initialize a database object from json string.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCollectionsLink() Gets the self-link for collections in the database
java.lang.String	getUsersLink() Gets the self-link for users in the database.

Methods inherited from JsonSerializable

<T>getCollection <T>getObject <T>set <T>toObject get getBoolean getCollection getDouble getHashMap getInt getLogger getLong getMapper getObject getObjectByPath getString has remove toJson toJson toString toString

Methods inherited from Resource

getETag getId getResourceId getSelfLink getTimestamp setId setResourceId

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

Database

public Database()

Initialize a database object.

Database

public Database(String jsonString)

Initialize a database object from json string.

Parameters:

jsonString - the json string.

Database

public Database(JSONObject jsonObject)

Initialize a database object from json string.

Parameters:

jsonObject - the json object.

Method Details

getCollectionsLink

public String getCollectionsLink()

Gets the self-link for collections in the database

Returns:

the collections link.

getUsersLink

public String getUsersLink()

Gets the self-link for users in the database.

Returns:

the users link.