DocumentClient.ReadDocumentFeedAsync
Method
Definition
Overloads
| ReadDocumentFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of documents for a specified collection from the Azure DocumentDB database service. This takes returns a ResourceResponse<TResource> which will contain an enumerable list of dynamic objects. |
| ReadDocumentFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of documents for a collection as an asynchronous operation from the Azure DocumentDB database service. |
ReadDocumentFeedAsync(String, FeedOptions)
Reads the feed (sequence) of documents for a specified collection from the Azure DocumentDB database service. This takes returns a ResourceResponse<TResource> which will contain an enumerable list of dynamic objects.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (string documentsLink, Microsoft.Azure.Documents.Client.FeedOptions options = null);
- documentsLink
- String
The SelfLink of the resources to be read. E.g. /dbs/db_rid/colls/coll_rid/docs/
- options
- FeedOptions
(Optional) The request options for the request.
A System.Threading.Tasks containing a ResourceResponse<TResource> containing dynamic objects representing the items in the feed.
If documentsLink is not set.
This exception can encapsulate many different types of errors. To determine the specific error always look at the StatusCode property. Some common codes you may get when creating a Document are:
| StatusCode | Reason for exception |
|---|---|
| 404 | NotFound - This means the resource feed you tried to read did not exist. Check the parent rids are correct. |
| 429 | TooManyRequests - This means you have exceeded the number of request units per second. Consult the DocumentClientException.RetryAfter value to see how long you should wait before retrying this operation. |
Remarks
Instead of FeedResponse{Document} this method takes advantage of dynamic objects in .NET. This way a single feed result can contain any kind of Document, or POCO object. This is important becuse a DocumentCollection can contain different kinds of documents.
ReadDocumentFeedAsync(Uri, FeedOptions)
Reads the feed (sequence) of documents for a collection as an asynchronous operation from the Azure DocumentDB database service.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<dynamic>> ReadDocumentFeedAsync (Uri documentsUri, Microsoft.Azure.Documents.Client.FeedOptions options = null);
- documentsUri
- Uri
the URI for the documents.
- options
- FeedOptions
The request options for the request.
The task object representing the service response for the asynchronous operation.