IDocumentClient.ReadDocumentFeedAsync Método

Definición

Espacio de nombres:

Microsoft.Azure.Documents

Ensamblados:

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

Paquetes:

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

Sobrecargas

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)	Lee la fuente (secuencia) de documentos de una colección como una operación asincrónica en el servicio Azure Cosmos DB.
ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)	Lee la fuente (secuencia) de documentos de una colección especificada del servicio Azure Cosmos DB. Esto devuelve un ResourceResponse<TResource> objeto que contendrá una lista enumerable de objetos dinámicos.

ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)

Lee la fuente (secuencia) de documentos de una colección como una operación asincrónica en el servicio 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))

Parámetros

documentCollectionUri

Uri

URI de la colección de documentos primaria.

options

FeedOptions

(Opcional) para FeedOptions la solicitud.

cancellationToken

CancellationToken

(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.

Devoluciones

Task<FeedResponse<Object>>

Objeto de tarea que representa la respuesta del servicio para la operación asincrónica.

ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)

Lee la fuente (secuencia) de documentos de una colección especificada del servicio Azure Cosmos DB. Esto devuelve un ResourceResponse<TResource> objeto que contendrá una lista enumerable de objetos dinámicos.

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

Parámetros

documentsLink

String

SelfLink de los recursos que se van a leer. Por ejemplo, /dbs/db_rid/colls/coll_rid/docs/

options

FeedOptions

(Opcional) Opciones de solicitud para la solicitud.

cancellationToken

CancellationToken

(Opcional) que CancellationToken pueden ser utilizados por otros objetos o subprocesos para recibir aviso de cancelación.

Devoluciones

Task<FeedResponse<Object>>

que System.Threading.Tasks contiene un ResourceResponse<TResource> objeto que contiene objetos dinámicos que representan los elementos de la fuente.

Excepciones

ArgumentNullException

Si documentsLink no se establece.

DocumentClientException

Esta excepción puede encapsular muchos tipos diferentes de errores. Para determinar el error específico, examine siempre la propiedad StatusCode. Algunos códigos comunes que puede obtener al crear un documento son:

StatusCode	Motivo de la excepción
404	NotFound: significa que la fuente de recursos que intentó leer no existía. Compruebe que los rid primarios son correctos.
429	TooManyRequests: esto significa que ha superado el número de unidades de solicitud por segundo. Consulte el valor DocumentClientException.RetryAfter para ver cuánto tiempo debe esperar antes de volver a intentar esta operación.

Ejemplos

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

Comentarios

En lugar de FeedResponse{Document} este método aprovecha los objetos dinámicos en .NET. De este modo, un único resultado de fuente puede contener cualquier tipo de documento o objeto POCO. Esto es importante que un DocumentCollection pueda contener diferentes tipos de documentos.

Consulte también

• ResourceResponse<TResource>
• Task
• RequestOptions