IDocumentClient.ReadDocumentFeedAsync Méthode

Définition

Espace de noms:

Microsoft.Azure.Documents

Assemblys:

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

Paquets:

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

Surcharges

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)	Lit le flux (séquence) de documents d’une collection en tant qu’opération asynchrone dans le service Azure Cosmos DB.
ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)	Lit le flux (séquence) de documents pour une collection spécifiée à partir du service Azure Cosmos DB. Cela prend retourne un ResourceResponse<TResource> qui contient une liste énumérable d’objets dynamiques.

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)

Lit le flux (séquence) de documents d’une collection en tant qu’opération asynchrone dans le service Azure Cosmos DB.

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))

Paramètres

documentCollectionUri

Uri

URI de la collection de documents parent.

options

FeedOptions

(Facultatif) FeedOptions pour la demande.

cancellationToken

CancellationToken

(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.

Retours

Task<FeedResponse<Object>>

Objet de tâche représentant la réponse du service pour l’opération asynchrone.

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

Lit le flux (séquence) de documents pour une collection spécifiée à partir du service Azure Cosmos DB. Cela prend retourne un ResourceResponse<TResource> qui contient une liste énumérable d’objets dynamiques.

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))

Paramètres

documentsLink

String

SelfLink des ressources à lire. Par exemple/dbs/db_rid/colls/coll_rid/docs/

options

FeedOptions

(Facultatif) Options de demande pour la demande.

cancellationToken

CancellationToken

(Facultatif) CancellationToken qui peut être utilisé par d’autres objets ou threads pour recevoir un avis d’annulation.

Retours

Task<FeedResponse<Object>>

System.Threading.Tasks contenant un contenant des ResourceResponse<TResource> objets dynamiques représentant les éléments du flux.

Exceptions

ArgumentNullException

Si documentsLink n’est pas défini.

DocumentClientException

Cette exception peut encapsuler de nombreux types d’erreurs différents. Pour déterminer l’erreur spécifique, examinez toujours la propriété StatusCode. Voici quelques codes courants que vous pouvez obtenir lors de la création d’un document :

StatusCode	Raison de l’exception
404	NotFound : cela signifie que le flux de ressources que vous avez tenté de lire n’existait pas. Vérifiez que les rids parent sont corrects.
429	TooManyRequests : cela signifie que vous avez dépassé le nombre d’unités de requête par seconde. Consultez la valeur DocumentClientException.RetryAfter pour savoir combien de temps vous devez attendre avant de réessayer cette opération.

Exemples

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));

Remarques

Au lieu de FeedResponse{Document}, cette méthode tire parti des objets dynamiques dans .NET. De cette façon, un seul résultat de flux peut contenir n’importe quel type d’objet Document ou POCO. Il est important de noter qu’un DocumentCollection peut contenir différents types de documents.

Voir aussi

• ResourceResponse<TResource>
• Task
• RequestOptions