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

(省略可能) 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[])

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[])

型パラメーター

パラメーター

戻り値

実装

例外

例

こちらもご覧ください

適用対象

その他のリソース