次の方法で共有


IDocumentClient.ReadDatabaseAsync メソッド

定義

オーバーロード

ReadDatabaseAsync(String, RequestOptions)

Database非同期操作として Azure Cosmos DB サービスから を読み取ります。

ReadDatabaseAsync(Uri, RequestOptions)

Databaseを Azure Cosmos DB サービスから非同期操作として読み取ります。

ReadDatabaseAsync(String, RequestOptions)

Database非同期操作として Azure Cosmos DB サービスから を読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> ReadDatabaseAsync (string databaseLink, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadDatabaseAsync : string * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
Public Function ReadDatabaseAsync (databaseLink As String, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))

パラメーター

databaseLink
String

読み取るデータベース リソースのリンク。

options
RequestOptions

(省略可能)要求の要求オプション。

戻り値

System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をDatabaseラップする を含む 。

例外

が設定されていない場合 databaseLink

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。

StatusCode例外の理由
404NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。
429TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter の値を調べ、この操作を再試行する前に待機する必要がある時間を確認します。

//Reads a Database resource where
// - database_id is the ID property of the Database resource you wish to read.
var dbLink = "/dbs/database_id";
Database database = await client.ReadDatabaseAsync(dbLink);

注釈

リソースの読み取りを行うことは、データベースからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。

次に示す例では、ID ベースのリンクを使用します。このリンクは、リソースの作成時に使用される ID プロパティで構成されます。 必要に応じて、 SelfLink Database の プロパティを引き続き使用できます。 セルフリンクは、リソース識別子 (または _rid プロパティ) で構成されるリソースの URI です。 ID ベースのリンクと SelfLink はどちらも機能します。 の databaseLink 形式は常に "/dbs/{db identifier}" であり、リソースのアドレス指定に使用するメソッドに応じて、変更内 {} の値のみが使用されます。

こちらもご覧ください

適用対象

ReadDatabaseAsync(Uri, RequestOptions)

Databaseを Azure Cosmos DB サービスから非同期操作として読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>> ReadDatabaseAsync (Uri databaseUri, Microsoft.Azure.Documents.Client.RequestOptions options = default);
abstract member ReadDatabaseAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.ResourceResponse<Microsoft.Azure.Documents.Database>>
Public Function ReadDatabaseAsync (databaseUri As Uri, Optional options As RequestOptions = Nothing) As Task(Of ResourceResponse(Of Database))

パラメーター

databaseUri
Uri

読み取るデータベース リソースへの URI。

options
RequestOptions

要求の要求オプション。

戻り値

System.Threading.Tasks読み取りリソース レコードをResourceResponse<TResource>含む をDatabaseラップする を含む 。

例外

が設定されていない場合 databaseUri

この例外は、さまざまな種類のエラーをカプセル化できます。 特定のエラーを特定するには、常に StatusCode プロパティを参照してください。 ドキュメントの作成時に取得できる一般的なコードは次のとおりです。

StatusCode例外の理由
404NotFound - 読み取ろうとしたリソースが存在しなかったことを意味します。
429TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter の値を調べ、この操作を再試行する前に待機する必要がある時間を確認します。

//Reads a Database resource where 
// - db_id is the ID property of the Database you wish to read. 
var dbLink = UriFactory.CreateDatabaseUri("db_id");
Database database = await client.ReadDatabaseAsync(dbLink);

注釈

リソースの読み取りを行うことは、サービスからリソースを取得する最も効率的な方法です。 リソースの ID がわかっている場合は、ID によるクエリではなく読み取りを行います。

こちらもご覧ください

適用対象