Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DocumentClient.ReadDatabaseAsync 方法

  • 参考

定义

命名空间:
Microsoft.Azure.Documents.Client
程序集:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
包:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

重载

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>>
override this.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

(可选) 请求的请求选项。

返回

Task<ResourceResponse<Database>>

包含 System.Threading.Tasks 的 ， ResourceResponse<TResource> 它包装 Database 包含读取资源记录的 。

实现

ReadDatabaseAsync(String, RequestOptions)

例外

ArgumentNullException

如果未 databaseLink 设置 。

DocumentClientException

此异常可以封装许多不同类型的错误。 若要确定特定错误，请始终查看 StatusCode 属性。 创建文档时可能会获取的一些常见代码包括：

StatusCode异常原因
404NotFound - 这意味着尝试读取的资源不存在。
429TooManyRequests - 这意味着已超出每秒请求单位数。 请参阅 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>>
override this.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

请求的请求选项。

返回

Task<ResourceResponse<Database>>

包含 System.Threading.Tasks 的 ， ResourceResponse<TResource> 它包装 Database 包含读取资源记录的 。

实现

ReadDatabaseAsync(Uri, RequestOptions)

例外

ArgumentNullException

如果未 databaseUri 设置 。

DocumentClientException

此异常可以封装许多不同类型的错误。 若要确定特定错误，请始终查看 StatusCode 属性。 创建文档时可能会获取的一些常见代码包括：

StatusCode异常原因
404NotFound - 这意味着尝试读取的资源不存在。
429TooManyRequests - 这意味着已超出每秒请求单位数。 请参阅 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 进行查询。

另请参阅

适用于