CosmosClient.GetDatabase(String) Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: CosmosClient.cs

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.

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

Database

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