FeedOptions.PartitionKeyRangeId Property

Reference

Definition

Namespace:: Microsoft.Azure.Documents.Client

Assemblies:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

Packages:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the partition key range id for the current request.

public string PartitionKeyRangeId { get; set; }

member this.PartitionKeyRangeId : string with get, set

Public Property PartitionKeyRangeId As String

Property Value

String

Examples

The following example shows how to read a document feed in a partitioned collection from partition key range "20".

await client.ReadDocumentFeedAsync(
    collection.SelfLink, 
    new RequestOptions { PartitionKeyRangeId = "20" } );

Remarks

ReadFeed requests can use this to forward request to specific range. This is usefull in case of bulk export scenarios.

Applies to

Share via