IDocumentClient.ExecuteStoredProcedureAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, CancellationToken, Object[]) |
Azure Cosmos DB サービスの非同期操作として、コレクションに対してストアド プロシージャを実行します。 |
ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, CancellationToken, Object[]) |
Azure Cosmos DB サービス内のパーティション分割されたコレクションに対してストアド プロシージャを非同期操作として実行し、ターゲット パーティションを指定します。 |
ExecuteStoredProcedureAsync<TValue>(Uri, RequestOptions, Object[]) |
Azure Cosmos DB サービスの非同期操作として、コレクションに対してストアド プロシージャを実行します。 |
ExecuteStoredProcedureAsync<TValue>(String, Object[]) |
Azure Cosmos DB サービスの非同期操作として、コレクションに対してストアド プロシージャを実行します。 |
ExecuteStoredProcedureAsync<TValue>(Uri, Object[]) |
Azure Cosmos DB サービスの非同期操作として、コレクションに対してストアド プロシージャを実行します。 |
ExecuteStoredProcedureAsync<TValue>(String, RequestOptions, Object[]) |
Azure Cosmos DB サービス内のパーティション分割されたコレクションに対してストアド プロシージャを非同期操作として実行し、ターゲット パーティションを指定します。 |
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, 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>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, options As RequestOptions, cancellationToken As CancellationToken, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))
型パラメーター
- TValue
ストアド プロシージャの戻り値の型。
パラメーター
- storedProcedureUri
- Uri
実行するストアド プロシージャの URI。
- options
- RequestOptions
(省略可能) RequestOptions 要求の 。
- cancellationToken
- CancellationToken
(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。
- procedureParams
- Object[]
ストアド プロシージャの実行のパラメーター。
戻り値
非同期操作のサービス応答を表すタスク オブジェクト。
適用対象
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>>
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
(省略可能) CancellationToken 取り消しの通知を受け取るために他のオブジェクトまたはスレッドで使用できる 。
- procedureParams
- Object[]
(省略可能)ストアド プロシージャのパラメーターを表す動的オブジェクトの配列。
戻り値
ストアド プロシージャに設定された応答を含む非同期操作のサービス応答を表すタスク オブジェクト。
例外
が設定されていない場合 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>>
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
(省略可能) RequestOptions 要求の 。
- procedureParams
- 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>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureLink As String, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))
型パラメーター
- TValue
ストアド プロシージャの戻り値の型。
パラメーター
- storedProcedureLink
- String
実行するストアド プロシージャへのリンク。
- procedureParams
- Object[]
(省略可能)ストアド プロシージャのパラメーターを表す動的オブジェクトの配列。
戻り値
ストアド プロシージャに設定された応答を含む非同期操作のサービス応答を表すタスク オブジェクト。
例外
が設定されていない場合 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>(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>>
Public Function ExecuteStoredProcedureAsync(Of TValue) (storedProcedureUri As Uri, ParamArray procedureParams As Object()) As Task(Of StoredProcedureResponse(Of TValue))
型パラメーター
- TValue
ストアド プロシージャの戻り値の型。
パラメーター
- storedProcedureUri
- Uri
実行するストアド プロシージャの URI。
- procedureParams
- Object[]
ストアド プロシージャの実行のパラメーター。
戻り値
非同期操作のサービス応答を表すタスク オブジェクト。
適用対象
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>>
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[]
(省略可能)ストアド プロシージャのパラメーターを表す動的オブジェクトの配列。
戻り値
ストアド プロシージャに設定された応答を含む非同期操作のサービス応答を表すタスク オブジェクト。
例外
が設定されていない場合 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");
こちらもご覧ください
適用対象
Azure SDK for .NET