FeedOptions.PartitionKeyRangeId Property

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

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.

See also

• DocumentCollection