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

DocumentClient.ReadDocumentFeedAsync 方法

定义

命名空间:

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

重载

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)	从 Azure Cosmos DB 服务读取指定集合的文档的源 (序列) 。 这将返回一个 ， ResourceResponse<TResource> 它将包含动态对象的可枚举列表。
ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)	从 Azure Cosmos DB 服务以异步操作的形式读取集合的文档的源 (序列) 。

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

从 Azure Cosmos DB 服务读取指定集合的文档的源 (序列) 。 这将返回一个 ， ResourceResponse<TResource> 它将包含动态对象的可枚举列表。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (string documentsLink, Microsoft.Azure.Documents.Client.FeedOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>
override this.ReadDocumentFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>

Public Function ReadDocumentFeedAsync (documentsLink As String, Optional options As FeedOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FeedResponse(Of Object))

参数

documentsLink

String

要读取的资源的 SelfLink。 例如 /dbs/db_rid/colls/coll_rid/docs/

options

FeedOptions

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

cancellationToken

CancellationToken

(可选) A CancellationToken ，其他对象或线程可以使用它来接收取消通知。

返回

Task<FeedResponse<Object>>

一个 System.Threading.TasksResourceResponse<TResource> ，它包含表示源中的项的动态对象。

实现

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

例外

ArgumentNullException

如果未 documentsLink 设置 。

DocumentClientException

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

StatusCode	异常原因
404	NotFound - 这意味着你尝试读取的资源源不存在。 检查父级 rid 是否正确。
429	TooManyRequests - 这意味着已超出每秒请求单位数。 请参阅 DocumentClientException.RetryAfter 值，了解在重试此操作之前应等待多长时间。

示例

int count = 0;
string continuation = string.Empty;
do
{
    // Read the feed 10 items at a time until there are no more items to read
    FeedResponse<dynamic> response = await client.ReadDocumentFeedAsync("/dbs/db_rid/colls/coll_rid/docs/",
                                                    new FeedOptions
                                                    {
                                                        MaxItemCount = 10,
                                                        RequestContinuation = continuation
                                                    });

    // Append the item count
    count += response.Count;

    // Get the continuation so that we know when to stop.
     continuation = response.ResponseContinuation;
} while (!string.IsNullOrEmpty(continuation));

注解

此方法利用 .NET 中的动态对象，而不是 FeedResponse{Document}。 这样一来，单个源结果可以包含任何类型的 Document 或 POCO 对象。 这一点很重要，因为 DocumentCollection 可以包含不同类型的文档。

另请参阅

• RequestOptions
• ResourceResponse<TResource>
• Task

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)

从 Azure Cosmos DB 服务以异步操作的形式读取集合的文档的源 (序列) 。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (Uri documentsUri, Microsoft.Azure.Documents.Client.FeedOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>
override this.ReadDocumentFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>

Public Function ReadDocumentFeedAsync (documentsUri As Uri, Optional options As FeedOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FeedResponse(Of Object))

参数

documentsUri

Uri

文档的 URI。

options

FeedOptions

请求的请求选项。

cancellationToken

CancellationToken

(表示请求取消的可选) CancellationToken 。

返回

Task<FeedResponse<Object>>

表示异步操作的服务响应的任务对象。

实现

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)