FeedOptions.PartitionKey Eigenschaft

Referenz

Definition

Namespace:: Microsoft.Azure.Documents.Client

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

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

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Ruft die für die PartitionKey aktuelle Anforderung im Azure Cosmos DB-Dienst ab oder legt diese fest.

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

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

Public Property PartitionKey As PartitionKey

Eigenschaftswert

PartitionKey

Beispiele

Das folgende Beispiel zeigt, wie Sie einen Dokumentfeed in einer partitionierten Auflistung mithilfe PartitionKeyvon lesen. Im Beispiel wird davon ausgegangen, dass die Auflistung mit einer PartitionKeyDefinition in der Eigenschaft "country" in allen Dokumenten erstellt wird.

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

Hinweise

Der Partitionsschlüssel ist erforderlich, wenn Lesedokumente oder Anlagen in eine partitionierte Sammlung eingespeist werden. Insbesondere ist der Partitionsschlüssel für erforderlich: ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)und ReadConflictFeedAsync(String, FeedOptions)ReadAttachmentFeedAsync(String, FeedOptions, CancellationToken) . Nur Dokumente in Partitionen, die das enthalten, PartitionKey werden im Ergebnis zurückgegeben.

Gilt für:

Freigeben über