Share via

Database Class

  • Reference
Package:
com.microsoft.azure.cosmosdb

public 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.

Method Summary

Modifier and Type Method and Description
String getCollectionsLink()

Gets the self-link for collections in the database
String getUsersLink()

Gets the self-link for users in the database.

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) Resource.Resource(Resource resource) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

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.

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.

Applies to