IDocumentClient.ExecuteStoredProcedureAsync Method

Definition

Overloads

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Executes a stored procedure against a partitioned collection as an asynchronous operation in the Azure DocumentDB database service, specifiying a target partition.

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

ExecuteStoredProcedureAsync<TValue>(String, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, object[] procedureParams);
Type Parameters
TValue

The type of the stored procedure's return value.

Parameters
storedProcedureLink
String

The link to the stored procedure to execute.

procedureParams
Object[]

(Optional) An array of dynamic objects representing the parameters for the stored procedure.

Returns

The task object representing the service response for the asynchronous operation which would contain any response set in the stored procedure.

Exceptions

If storedProcedureLink is not set.

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, object[] procedureParams);
Type Parameters
TValue

The type of the stored procedure's return value.

Parameters
storedProcedureUri
Uri

The URI of the stored procedure to be executed.

procedureParams
Object[]

The parameters for the stored procedure execution.

Returns

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

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])

Executes a stored procedure against a partitioned collection as an asynchronous operation in the Azure DocumentDB database service, specifiying a target partition.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (string storedProcedureLink, Microsoft.Azure.Documents.Client.RequestOptions options, object[] procedureParams);
Type Parameters
TValue

The type of the stored procedure's return value.

Parameters
storedProcedureLink
String

The link to the stored procedure to execute.

options
RequestOptions

(Optional) The RequestOptionsfor this request.

procedureParams
Object[]

(Optional) An array of dynamic objects representing the parameters for the stored procedure.

Returns

The task object representing the service response for the asynchronous operation which would contain any response set in the stored procedure.

Exceptions

If storedProcedureLink is not set.

ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])

Executes a stored procedure against a collection as an asynchronous operation in the Azure DocumentDB database service.

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, object[] procedureParams);
Type Parameters
TValue

The type of the stored procedure's return value.

Parameters
storedProcedureUri
Uri

The URI of the stored procedure to be executed.

options
RequestOptions

(Optional) The RequestOptions for the request.

procedureParams
Object[]

The parameters for the stored procedure execution.

Returns

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