FeedOptions.PartitionKey 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 PartitionKey for the current request in the Azure Cosmos DB service.

public Microsoft.Azure.Documents.PartitionKey PartitionKey { get; set; }

member this.PartitionKey : Microsoft.Azure.Documents.PartitionKey with get, set

Public Property PartitionKey As PartitionKey

Property Value

PartitionKey

Examples

The following example shows how to read a document feed in a partitioned collection using PartitionKey. The example assumes the collection is created with a PartitionKeyDefinition on the 'country' property in all the documents.

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

Remarks

Partition key is required when read documents or attachments feed in a partitioned collection. Specifically Partition key is required for : ReadDocumentFeedAsync(String, FeedOptions, CancellationToken), ReadAttachmentFeedAsync(String, FeedOptions, CancellationToken) and ReadConflictFeedAsync(String, FeedOptions). Only documents in partitions containing the PartitionKey is returned in the result.

Applies to

Share via