CosmosScripts.ExecuteStoredProcedureStreamAsync メソッド

  • リファレンス

定義

名前空間:
Azure.Cosmos.Scripts
アセンブリ:
Azure.Cosmos.dll
パッケージ:
Azure.Cosmos v4.0.0-preview3

Azure Cosmos サービスの非同期操作としてコンテナーに対してストアド プロシージャを実行し、応答として Stream を取得します。

public abstract System.Threading.Tasks.Task<Azure.Response> ExecuteStoredProcedureStreamAsync (string storedProcedureId, Azure.Cosmos.PartitionKey partitionKey, object[] parameters, Azure.Cosmos.StoredProcedureRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);
abstract member ExecuteStoredProcedureStreamAsync : string * Azure.Cosmos.PartitionKey * obj[] * Azure.Cosmos.StoredProcedureRequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response>
Public MustOverride Function ExecuteStoredProcedureStreamAsync (storedProcedureId As String, partitionKey As PartitionKey, parameters As Object(), Optional requestOptions As StoredProcedureRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response)

パラメーター

storedProcedureId
String

実行するストアド プロシージャの識別子。

partitionKey
PartitionKey

項目のパーティション キー。 PartitionKey

parameters
Object[]

(省略可能)ストアド プロシージャのパラメーターを表す動的オブジェクトの配列。

requestOptions
StoredProcedureRequestOptions

(省略可能)ストアド プロシージャ要求のオプション StoredProcedureRequestOptions

cancellationToken
CancellationToken

(省略可能) CancellationToken 要求の取り消しを表します。

戻り値

Task<Response>

ストアド プロシージャに設定された応答を含む非同期操作のサービス応答を表すタスク オブジェクト。

例外

ArgumentNullException

または partitionKey が設定されていない場合storedProcedureId。

例

これにより、クエリから返された最初の項目に文字列を追加するストアド プロシージャが作成され、実行されます。

string sprocBody = @"function simple(prefix, postfix)
   {
       var collection = getContext().getCollection();

       // Query documents and take 1st item.
       var isAccepted = collection.queryDocuments(
       collection.getSelfLink(),
       'SELECT * FROM root r',
       function(err, feed, options) {
           if (err)throw err;

           // Check the feed and if it's empty, set the body to 'no docs found',
           // Otherwise just take 1st element from the feed.
           if (!feed || !feed.length) getContext().getResponse().setBody(""no docs found"");
           else getContext().getResponse().setBody(prefix + JSON.stringify(feed[0]) + postfix);
       });

       if (!isAccepted) throw new Error(""The query wasn't accepted by the server. Try again/use continuation token between API and script."");
   }";

CosmosScripts scripts = this.container.Scripts;
string sprocId = "appendString";
Response<StoredProcedureProperties> storedProcedureResponse = await scripts.CreateStoredProcedureAsync(
        sprocId,
        sprocBody);

// Execute the stored procedure
Response sprocResponse = await scripts.ExecuteStoredProcedureStreamAsync(
                        sprocId,
                        new PartitionKey(testPartitionId),
                        new dynamic[] {"myPrefixString", "myPostfixString"});

using (StreamReader sr = new StreamReader(sprocResponse.ContentStream))
{
    string stringResponse = await sr.ReadToEndAsync();
    Console.WriteLine(stringResponse);
 }

///

適用対象