IDocumentClient.ReadDocumentFeedAsync Methode

Definition

Namespace:

Microsoft.Azure.Documents

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

Überlädt

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)	Liest den Feed (die Sequenz) von Dokumenten für eine Sammlung als asynchronen Vorgang im Azure Cosmos DB-Dienst.
ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)	Liest den Feed (die Sequenz) von Dokumenten für eine angegebene Sammlung aus dem Azure Cosmos DB-Dienst. Dadurch wird eine ResourceResponse<TResource> zurückgegeben, die eine aufzählbare Liste dynamischer Objekte enthält.

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)

Liest den Feed (die Sequenz) von Dokumenten für eine Sammlung als asynchronen Vorgang im Azure Cosmos DB-Dienst.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.FeedOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>

Public Function ReadDocumentFeedAsync (documentCollectionUri As Uri, Optional options As FeedOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FeedResponse(Of Object))

Parameter

documentCollectionUri

Uri

Der URI der übergeordneten Dokumentauflistung.

options

FeedOptions

(Optional) Die FeedOptions für die Anforderung.

cancellationToken

CancellationToken

(Optional) Ein CancellationToken , der von anderen Objekten oder Threads verwendet werden kann, um eine Benachrichtigung über den Abbruch zu erhalten.

Gibt zurück

Task<FeedResponse<Object>>

Das Aufgabenobjekt, das die Dienstantwort für den asynchronen Vorgang darstellt.

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

Liest den Feed (die Sequenz) von Dokumenten für eine angegebene Sammlung aus dem Azure Cosmos DB-Dienst. Dadurch wird eine ResourceResponse<TResource> zurückgegeben, die eine aufzählbare Liste dynamischer Objekte enthält.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (string documentsLink, Microsoft.Azure.Documents.Client.FeedOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member ReadDocumentFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>

Public Function ReadDocumentFeedAsync (documentsLink As String, Optional options As FeedOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of FeedResponse(Of Object))

Parameter

documentsLink

String

Der SelfLink der zu lesenden Ressourcen. Beispiel: /dbs/db_rid/colls/coll_rid/docs/

options

FeedOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) Ein CancellationToken , der von anderen Objekten oder Threads verwendet werden kann, um eine Benachrichtigung über den Abbruch zu erhalten.

Gibt zurück

Task<FeedResponse<Object>>

Ein System.Threading.Tasks mit dynamischen ResourceResponse<TResource> Objekten, die die Elemente im Feed darstellen.

Ausnahmen

ArgumentNullException

Wenn documentsLink nicht festgelegt ist.

DocumentClientException

Diese Ausnahme kann viele verschiedene Fehlertypen kapseln. Um den spezifischen Fehler zu ermitteln, sehen Sie sich immer die StatusCode-Eigenschaft an. Einige häufige Codes, die Sie beim Erstellen eines Dokuments erhalten können, sind:

StatusCode	Grund für die Ausnahme
404	NotFound: Dies bedeutet, dass der Ressourcenfeed, den Sie lesen möchten, nicht vorhanden war. Überprüfen Sie, ob die übergeordneten Rids korrekt sind.
429	TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den DocumentClientException.RetryAfter-Wert, um zu sehen, wie lange Sie warten sollten, bevor Sie diesen Vorgang wiederholen.

Beispiele

int count = 0;
string continuation = string.Empty;
do
{
    // Read the feed 10 items at a time until there are no more items to read
    FeedResponse<dynamic> response = await client.ReadDocumentFeedAsync("/dbs/db_rid/colls/coll_rid/docs/",
                                                    new FeedOptions
                                                    {
                                                        MaxItemCount = 10,
                                                        RequestContinuation = continuation
                                                    });

    // Append the item count
    count += response.Count;

    // Get the continuation so that we know when to stop.
     continuation = response.ResponseContinuation;
} while (!string.IsNullOrEmpty(continuation));

Hinweise

Anstelle von FeedResponse{Document} nutzt diese Methode dynamische Objekte in .NET. Auf diese Weise kann ein einzelnes Feedergebnis jede Art von Document- oder POCO-Objekt enthalten. Dies ist wichtig, wenn eine DocumentCollection verschiedene Arten von Dokumenten enthalten kann.

Weitere Informationen

• ResourceResponse<TResource>
• Task
• RequestOptions