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

(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドが使用できる 。

戻り値

Task<FeedResponse<Object>>

System.Threading.Tasksフィード内の項目をResourceResponse<TResource>表す動的オブジェクトを格納する 。

実装

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

例外

ArgumentNullException

が設定されていない場合 documentsLink 。

DocumentClientException

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

StatusCode	例外の理由
404	NotFound - これは、読み取ろうとしたリソース フィードが存在しなかったことを意味します。 親の取り除きが正しいことを確認します。
429	TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 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));

注釈

FeedResponse{Document} の代わりに、このメソッドは .NET の動的オブジェクトを利用します。 これにより、1 つのフィード結果に任意の種類の Document オブジェクトまたは POCO オブジェクトを含めることができます。 これは重要です。DocumentCollection にはさまざまな種類のドキュメントを含めることができます。

こちらもご覧ください

• ResourceResponse<TResource>
• Task
• RequestOptions

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)