你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

DocumentClient.ExecuteStoredProcedureAsync 方法

参考

定义

命名空间:: Microsoft.Azure.Documents.Client

程序集:: Microsoft.Azure.DocumentDB.Core.dll, Microsoft.Azure.Documents.Client.dll

包:: Microsoft.Azure.DocumentDB v2.18.0, Microsoft.Azure.DocumentDB.Core v2.18.0

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[])	以异步操作的形式针对 Azure Cosmos DB 服务中的分区集合执行存储过程，指定目标分区。
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[])	对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[])	对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。
ExecuteStoredProcedureAsync<TValue>(Uri, Object[])	对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。
ExecuteStoredProcedureAsync<TValue>(String, Object[])	对集合执行存储过程，作为 Azure Cosmos DB 服务中的异步操作。
ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[])	以异步操作的形式针对 Azure Cosmos DB 服务中的分区集合执行存储过程，指定目标分区。

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

以异步操作的形式针对 Azure Cosmos DB 服务中的分区集合执行存储过程，指定目标分区。

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

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, cancellationToken As CancellationToken, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureLink: String

指向要执行的存储过程的链接。

options: RequestOptions

(可选) 请求的请求选项。

cancellationToken: CancellationToken

(可选) A CancellationToken ，其他对象或线程可以使用它来接收取消通知。

procedureParams: Object[]

(可选) 表示存储过程参数的动态对象数组。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象，该操作将包含存储过程中的任何响应集。

实现

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

例外

ArgumentNullException

如果未 storedProcedureLink 设置。

示例

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

另请参阅

适用于

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

对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。

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

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureUri: Uri

要执行的存储过程的 URI。

options: RequestOptions

请求的请求选项。

procedureParams: Object[]

存储过程执行的参数。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象。

实现

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

适用于

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

对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。

public System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<TValue>> ExecuteStoredProcedureAsync<TValue> (Uri storedProcedureUri, Microsoft.Azure.Documents.Client.RequestOptions options, System.Threading.CancellationToken cancellationToken = default, params object[] procedureParams);

abstract member ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * Microsoft.Azure.Documents.Client.RequestOptions * System.Threading.CancellationToken * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, Optional cancellationToken As CancellationToken = Nothing, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureUri: Uri

要执行的存储过程的 URI。

options: RequestOptions

请求的请求选项。

cancellationToken: CancellationToken

(表示请求取消的可选) CancellationToken 。

procedureParams: Object[]

存储过程执行的参数。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象。

实现

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

适用于

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

对集合执行存储过程，作为 Azure Cosmos DB 服务的异步操作。

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

abstract member ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : Uri * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureUri: Uri

要执行的存储过程的 URI。

procedureParams: Object[]

存储过程执行的参数。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象。

实现

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

适用于

ExecuteStoredProcedureAsync<TValue>(String, Object[])

对集合执行存储过程，作为 Azure Cosmos DB 服务中的异步操作。

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

abstract member ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureLink: String

指向要执行的存储过程的链接。

procedureParams: Object[]

(可选) 表示存储过程参数的动态对象数组。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象，该操作将包含存储过程中的任何响应集。

实现

ExecuteStoredProcedureAsync<TValue>(String, Object[])

例外

ArgumentNullException

如果未 storedProcedureLink 设置。

示例

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

另请参阅

适用于

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

以异步操作的形式针对 Azure Cosmos DB 服务中的分区集合执行存储过程，指定目标分区。

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

abstract member ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>
override this.ExecuteStoredProcedureAsync : string * Microsoft.Azure.Documents.Client.RequestOptions * obj[] -> System.Threading.Tasks.Task<Microsoft.Azure.Documents.Client.StoredProcedureResponse<'Value>>

Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, options As RequestOptions, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))

类型参数

TValue

存储过程的返回值的类型。

参数

storedProcedureLink: String

指向要执行的存储过程的链接。

options: RequestOptions

(可选) 请求的请求选项。

procedureParams: Object[]

(可选) 表示存储过程参数的动态对象数组。

Task<StoredProcedureResponse<TValue>>

表示异步操作的服务响应的任务对象，该操作将包含存储过程中的任何响应集。

实现

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

例外

ArgumentNullException

如果未 storedProcedureLink 设置。

示例

//Execute a StoredProcedure with ResourceId of "sproc_rid" that takes two "Player" documents, does some stuff, and returns a bool
StoredProcedureResponse<bool> sprocResponse = await client.ExecuteStoredProcedureAsync<bool>(
                                                        "/dbs/db_rid/colls/col_rid/sprocs/sproc_rid/",
                                                        new RequestOptions { PartitionKey = new PartitionKey(1) },
                                                        new Player { id="1", name="joe" } ,
                                                        new Player { id="2", name="john" }
                                                    );

if (sprocResponse.Response) Console.WriteLine("Congrats, the stored procedure did some stuff");

另请参阅

适用于

通过

DocumentClient.ExecuteStoredProcedureAsync 方法

定义

重载

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

类型参数

参数

返回

实现

例外

示例

另请参阅

适用于

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

类型参数

参数

返回

实现

适用于

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

类型参数

参数

返回

实现

适用于

ExecuteStoredProcedureAsync<TValue>(Uri, Object[])

类型参数

参数

返回

实现

适用于

ExecuteStoredProcedureAsync<TValue>(String, Object[])

类型参数

参数

返回

实现

例外

示例

另请参阅

适用于

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

类型参数

参数

返回

实现

例外

示例

另请参阅

适用于

其他资源