DocumentClient.ReadDocumentFeedAsync Método
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Sobrecargas
| ReadDocumentFeedAsync(String, FeedOptions, CancellationToken) |
Lê o feed (sequência) de documentos de uma coleção especificada do serviço do Azure Cosmos DB. Isso retorna um ResourceResponse<TResource> que conterá uma lista enumerável de objetos dinâmicos. |
| ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken) |
Lê o feed (sequência) de documentos de uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB. |
ReadDocumentFeedAsync(String, FeedOptions, CancellationToken)
Lê o feed (sequência) de documentos de uma coleção especificada do serviço do Azure Cosmos DB. Isso retorna um ResourceResponse<TResource> que conterá uma lista enumerável 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>>
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))Parâmetros
- documentsLink
- String
O SelfLink dos recursos a serem lidos. Por exemplo, /dbs/db_rid/colls/coll_rid/docs/
- options
- FeedOptions
(Opcional) As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) Um CancellationToken que pode ser usado por outros objetos ou threads para receber uma notificação de cancelamento.
Retornos
Um System.Threading.Tasks que contém um ResourceResponse<TResource> que contém objetos dinâmicos que representam os itens no feed.
Implementações
Exceções
Se documentsLink não estiver definido.
Essa exceção pode encapsular muitos tipos diferentes de erros. Para determinar o erro específico, sempre examine a propriedade StatusCode. Alguns códigos comuns que você pode obter ao criar um Documento são:
| StatusCode | Motivo da exceção |
|---|---|
| 404 | NotFound - Isso significa que o feed de recursos que você tentou ler não existia. Verifique se os rids pai estão corretos. |
| 429 | TooManyRequests - Isso significa que você excedeu o número de unidades de solicitação por segundo. Consulte o valor DocumentClientException.RetryAfter para ver quanto tempo você deve aguardar antes de repetir essa operação. |
Exemplos
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));
Comentários
Em vez de FeedResponse{Document} esse método aproveita os objetos dinâmicos no .NET. Dessa forma, um único resultado de feed pode conter qualquer tipo de objeto Document ou POCO. Isso é importante porque um DocumentCollection pode conter diferentes tipos de documentos.
Confira também
Aplica-se a
ReadDocumentFeedAsync(Uri, FeedOptions, CancellationToken)
Lê o feed (sequência) de documentos de uma coleção como uma operação assíncrona do serviço do Azure Cosmos DB.
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))Parâmetros
- documentsUri
- Uri
o URI dos documentos.
- options
- FeedOptions
As opções de solicitação para a solicitação.
- cancellationToken
- CancellationToken
(Opcional) CancellationToken que representa o cancelamento da solicitação.
Retornos
O objeto de tarefa que representa a resposta do serviço para a operação assíncrona.
Implementações
Aplica-se a
Azure SDK for .NET