IDocumentClient.CreateDatabaseAsync(Database, RequestOptions) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Creates a database resource as an asychronous operation in the Azure Cosmos DB service.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> CreateDatabaseAsync (Microsoft.Azure.Documents.Database database, Microsoft.Azure.Documents.Client.RequestOptions options = default);abstract member CreateDatabaseAsync : Microsoft.Azure.Documents.Database * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>Public Function CreateDatabaseAsync (database As Database, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))Parameters
- options
- RequestOptions
(Optional) The RequestOptions for the request.
Returns
The Database that was created within a task object representing the service response for the asynchronous operation.
Exceptions
If database is not set.
Represents a consolidation of failures that occured during async processing. Look within InnerExceptions to find the actual exception(s).
This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Database are:
| StatusCode | Reason for exception |
|---|---|
| 400 | BadRequest - This means something was wrong with the database object supplied. It is likely that an id was not supplied for the new Database. |
| 409 | Conflict - This means a Database with an id matching the id field of database already existed. |
Examples
The example below creates a new Database with an Id property of 'MyDatabase' This code snippet is intended to be used from within an asynchronous method as it uses the await keyword
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Database db = await client.CreateDatabaseAsync(new Database { Id = "MyDatabase" });
}
If you would like to construct a Database from within a synchronous method then you need to use the following code
using (IDocumentClient client = new DocumentClient(new Uri("service endpoint"), "auth key"))
{
Database db = client.CreateDatabaseAsync(new Database { Id = "MyDatabase" }).Result;
}
