DocumentClient.ReadDocumentCollectionFeedAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| ReadDocumentCollectionFeedAsync(String, FeedOptions) |
Reads the feed (sequence) of DocumentCollection for a database from the Azure Cosmos DB service as an asynchronous operation. |
| ReadDocumentCollectionFeedAsync(Uri, FeedOptions) |
Reads the feed (sequence) of collections for a database as an asynchronous operation from the Azure Cosmos DB service. |
ReadDocumentCollectionFeedAsync(String, FeedOptions)
Reads the feed (sequence) of DocumentCollection for a database from the Azure Cosmos DB service as an asynchronous operation.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionFeedAsync (string collectionsLink, Microsoft.Azure.Documents.Client.FeedOptions options = default);abstract member ReadDocumentCollectionFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.ReadDocumentCollectionFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>>Public Function ReadDocumentCollectionFeedAsync (collectionsLink As String, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of DocumentCollection))Parameters
- collectionsLink
- String
The SelfLink of the resources to be read. E.g. /dbs/db_rid/colls/
- options
- FeedOptions
(Optional) The request options for the request.
Returns
A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a DocumentCollection containing the read resource record.
Implements
Exceptions
If collectionsLink 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. |
Examples
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<DocumentCollection> response = await client.ReadDocumentCollectionFeedAsync("/dbs/db_rid/colls/",
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));
See also
Applies to
ReadDocumentCollectionFeedAsync(Uri, FeedOptions)
Reads the feed (sequence) of collections for a database as an asynchronous operation from the Azure Cosmos DB service.
public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionFeedAsync (Uri documentCollectionsUri, Microsoft.Azure.Documents.Client.FeedOptions options = default);abstract member ReadDocumentCollectionFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>>
override this.ReadDocumentCollectionFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>>Public Function ReadDocumentCollectionFeedAsync (documentCollectionsUri As Uri, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of DocumentCollection))Parameters
- documentCollectionsUri
- Uri
the URI for the document collections.
- options
- FeedOptions
The request options for the request.
Returns
The task object representing the service response for the asynchronous operation.
