DocumentClient.ReadPartitionKeyRangeFeedAsync メソッド

  • リファレンス

定義

名前空間:
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

オーバーロード

ReadPartitionKeyRangeFeedAsync(Uri, FeedOptions)

非同期操作として、Azure Cosmos DB サービスからデータベース アカウントの フィード (シーケンス) PartitionKeyRange を読み取ります。
ReadPartitionKeyRangeFeedAsync(String, FeedOptions)

非同期操作として、Azure Cosmos DB サービスからデータベース アカウントの フィード (シーケンス) PartitionKeyRange を読み取ります。

ReadPartitionKeyRangeFeedAsync(Uri, FeedOptions)

非同期操作として、Azure Cosmos DB サービスからデータベース アカウントの フィード (シーケンス) PartitionKeyRange を読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>> ReadPartitionKeyRangeFeedAsync (Uri partitionKeyRangesOrCollectionUri, Microsoft.Azure.Documents.Client.FeedOptions options = default);
abstract member ReadPartitionKeyRangeFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>>
override this.ReadPartitionKeyRangeFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>>
Public Function ReadPartitionKeyRangeFeedAsync (partitionKeyRangesOrCollectionUri As Uri, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of PartitionKeyRange))

パラメーター

partitionKeyRangesOrCollectionUri
Uri

パーティション キー範囲の URI、または所有者コレクション。

options
FeedOptions

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

戻り値

Task<FeedResponse<PartitionKeyRange>>

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

実装

ReadPartitionKeyRangeFeedAsync(Uri, FeedOptions)

例

Uri partitionKeyRangesUri = UriFactory.CreatePartitionKeyRangesUri(database.Id, collection.Id);
FeedResponse<PartitionKeyRange> response = null;
List<string> ids = new List<string>();
do
{
    response = await client.ReadPartitionKeyRangeFeedAsync(partitionKeyRangesUri, new FeedOptions { MaxItemCount = 1000 });
    foreach (var item in response)
    {
        ids.Add(item.Id);
    }
}
while (!string.IsNullOrEmpty(response.ResponseContinuation));

こちらもご覧ください

適用対象

ReadPartitionKeyRangeFeedAsync(String, FeedOptions)

非同期操作として、Azure Cosmos DB サービスからデータベース アカウントの フィード (シーケンス) PartitionKeyRange を読み取ります。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>> ReadPartitionKeyRangeFeedAsync (string partitionKeyRangesOrCollectionLink, Microsoft.Azure.Documents.Client.FeedOptions options = default);
abstract member ReadPartitionKeyRangeFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>>
override this.ReadPartitionKeyRangeFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.PartitionKeyRange>>
Public Function ReadPartitionKeyRangeFeedAsync (partitionKeyRangesOrCollectionLink As String, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of PartitionKeyRange))

パラメーター

partitionKeyRangesOrCollectionLink
String

読み取るリソースのリンク、または所有者コレクション リンク、SelfLink または AltLink。 例: /dbs/db_rid/colls/coll_rid/pkranges

options
FeedOptions

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

戻り値

Task<FeedResponse<PartitionKeyRange>>

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

実装

ReadPartitionKeyRangeFeedAsync(String, FeedOptions)

例外

DocumentClientException

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

StatusCode例外の理由
429TooManyRequests - つまり、1 秒あたりの要求ユニット数を超えています。 DocumentClientException.RetryAfter 値を調べ、この操作を再試行するまでの待機時間を確認します。

例

FeedResponse<PartitionKeyRange> response = null;
List<string> ids = new List<string>();
do
{
    response = await client.ReadPartitionKeyRangeFeedAsync(collection.SelfLink, new FeedOptions { MaxItemCount = 1000 });
    foreach (var item in response)
    {
        ids.Add(item.Id);
    }
}
while (!string.IsNullOrEmpty(response.ResponseContinuation));

こちらもご覧ください

適用対象