Share via

IDocumentClient.ReadUserDefinedFunctionFeedAsync Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Documents
Assemblies:
Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll
Packages:
Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

Overloads

ReadUserDefinedFunctionFeedAsync(Uri, FeedOptions)

Reads the feed (sequence) of user defined functions for a collection as an asynchronous operation in the Azure Cosmos DB service.
ReadUserDefinedFunctionFeedAsync(String, FeedOptions)

Reads the feed (sequence) of UserDefinedFunction for a collection from the Azure Cosmos DB service as an asynchronous operation.

ReadUserDefinedFunctionFeedAsync(Uri, FeedOptions)

Reads the feed (sequence) of user defined functions for a collection as an asynchronous operation in the Azure Cosmos DB service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionFeedAsync (Uri documentCollectionUri, Microsoft.Azure.Documents.Client.FeedOptions options = default);
abstract member ReadUserDefinedFunctionFeedAsync : Uri * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function ReadUserDefinedFunctionFeedAsync (documentCollectionUri As Uri, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of UserDefinedFunction))

Parameters

documentCollectionUri
Uri

The URI of the parent document collection.

options
FeedOptions

(Optional) The FeedOptions for the request.

Returns

Task<FeedResponse<UserDefinedFunction>>

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

Applies to

ReadUserDefinedFunctionFeedAsync(String, FeedOptions)

Reads the feed (sequence) of UserDefinedFunction for a collection from the Azure Cosmos DB service as an asynchronous operation.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.UserDefinedFunction>> ReadUserDefinedFunctionFeedAsync (string userDefinedFunctionsLink, Microsoft.Azure.Documents.Client.FeedOptions options = default);
abstract member ReadUserDefinedFunctionFeedAsync : string * Microsoft.Azure.Documents.Client.FeedOptions -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.FeedResponse<Microsoft.Azure.Documents.UserDefinedFunction>>
Public Function ReadUserDefinedFunctionFeedAsync (userDefinedFunctionsLink As String, Optional options As FeedOptions = Nothing) As Task(Of FeedResponse(Of UserDefinedFunction))

Parameters

userDefinedFunctionsLink
String

The SelfLink of the resources to be read. E.g. /dbs/db_rid/colls/col_rid/udfs/

options
FeedOptions

(Optional) The request options for the request.

Returns

Task<FeedResponse<UserDefinedFunction>>

A System.Threading.Tasks containing a ResourceResponse<TResource> which wraps a UserDefinedFunction containing the read resource record.

Exceptions

ArgumentNullException

If userDefinedFunctionsLink is not set.

DocumentClientException

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<UserDefinedFunction> response = await client.ReadUserDefinedFunctionFeedAsync("/dbs/db_rid/colls/col_rid/udfs/",
                                                    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