Share via


CosmosClient.GetDatabase(String) Method

Definition

Returns a proxy reference to a database.

public virtual Microsoft.Azure.Cosmos.Database GetDatabase (string id);
abstract member GetDatabase : string -> Microsoft.Azure.Cosmos.Database
override this.GetDatabase : string -> Microsoft.Azure.Cosmos.Database
Public Overridable Function GetDatabase (id As String) As Database

Parameters

id
String

The Cosmos database id

Returns

Cosmos database proxy

Examples

Database db = cosmosClient.GetDatabase("myDatabaseId");
DatabaseResponse response = await db.ReadAsync();

Remarks

Database proxy reference doesn't guarantee existence. Please ensure database exists through CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken) or CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken), before operating on it.

Applies to