DocumentClient.ReadDocumentFeedAsync Methode

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

Überlädt

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)	Liest den Feed (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 (Sequenz) von Dokumenten für eine Sammlung als asynchronen Vorgang aus dem Azure Cosmos DB-Dienst.

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

Liest den Feed (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>>
override this.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. Z.B. /dbs/db_rid/colls/coll_rid/docs/

options

FeedOptions

(Optional) Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) Eine CancellationToken , die von anderen Objekten oder Threads verwendet werden kann, um eine Kündigungsbenachrichtigung zu erhalten.

Gibt zurück

Task<FeedResponse<Object>>

Eine System.Threading.Tasks , die ein ResourceResponse<TResource> enthält dynamische Objekte, die die Elemente im Feed darstellen.

Implementiert

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

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, sind:

StatusCode	Ausnahmegrund
404	NotFound: Dies bedeutet, dass der Ressourcenfeed, den Sie lesen möchten, nicht vorhanden war. Überprüfen Sie, ob die übergeordneten Rids richtig sind.
429	TooManyRequests: Dies bedeutet, dass Sie die Anzahl der Anforderungseinheiten pro Sekunde überschritten haben. Lesen Sie den Wert DocumentClientException.RetryAfter, um zu ermitteln, 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 eine beliebige Art von Document oder POCO-Objekt enthalten. Dies ist wichtig, wenn eine DocumentCollection verschiedene Arten von Dokumenten enthalten kann.

Weitere Informationen

• RequestOptions
• ResourceResponse<TResource>
• Task

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)

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

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (Uri documentsUri, 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>>
override this.ReadDocumentFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<obj>>

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

Parameter

documentsUri

Uri

der URI für die Dokumente.

options

FeedOptions

Die Anforderungsoptionen für die Anforderung.

cancellationToken

CancellationToken

(Optional) CancellationToken stellt die Anforderungsabbruch dar.

Gibt zurück

Task<FeedResponse<Object>>

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

Implementiert

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)