IDocumentClient.ReadDocumentCollectionFeedAsync Method

Definition

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 in 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 = null);
abstract member 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 = null) 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.

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:

StatusCodeReason for exception
404NotFound - This means the resource feed you tried to read did not exist. Check the parent rids are correct.
429TooManyRequests - 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

ReadDocumentCollectionFeedAsync(Uri, FeedOptions)

Reads the feed (sequence) of collections for a database as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>> ReadDocumentCollectionFeedAsync (Uri databaseUri, Microsoft.Azure.Documents.Client.FeedOptions options = null);
abstract member ReadDocumentCollectionFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.DocumentCollection>>
Public Function ReadDocumentCollectionFeedAsync (databaseUri As Uri, Optional options As FeedOptions = null) As Task(Of FeedResponse(Of DocumentCollection))

Parameters

databaseUri
Uri

The URI of the parent Database.

options
FeedOptions

(Optional) The FeedOptions for the request.

Returns

The task object representing the service response for the asynchronous operation.

Applies to