Scripts.GetStoredProcedureQueryStreamIterator メソッド

定義

名前空間:

Microsoft.Azure.Cosmos.Scripts

アセンブリ:

Microsoft.Azure.Cosmos.Client.dll

パッケージ:

Microsoft.Azure.Cosmos v3.39.0

オーバーロード

GetStoredProcedureQueryStreamIterator(String, String, QueryRequestOptions)	このメソッドは、SQL ステートメントを使用してコンテナーの下にストアド プロシージャのクエリを作成します。 FeedIterator を返します。
GetStoredProcedureQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、コンテナーの下にストアド プロシージャのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。

GetStoredProcedureQueryStreamIterator(String, String, QueryRequestOptions)

ソース:

Scripts.cs

このメソッドは、SQL ステートメントを使用してコンテナーの下にストアド プロシージャのクエリを作成します。 FeedIterator を返します。

public abstract Microsoft.Azure.Cosmos.FeedIterator GetStoredProcedureQueryStreamIterator (string queryText = default, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetStoredProcedureQueryStreamIterator : string * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator

Public MustOverride Function GetStoredProcedureQueryStreamIterator (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator

パラメーター

queryText

String

Cosmos SQL クエリ テキスト。

continuationToken

String

(省略可能)Azure Cosmos DB サービスの継続トークン。

requestOptions

QueryRequestOptions

(省略可能)項目クエリ要求のオプション。

戻り値

FeedIterator

既存のストアド プロシージャを読み取る反復子。

例

これにより、入力として queryText を使用する sproc のストリーム フィード反復子が作成されます。

Scripts scripts = this.container.Scripts;
string queryText = "SELECT * FROM s where s.id like '%testId%'";
using (FeedIterator feedIterator = this.scripts.GetStoredProcedureQueryStreamIterator(queryText)
{
    while (feedIterator.HasMoreResults)
    {
        // Stream iterator returns a response with status for errors
        using(ResponseMessage response = await feedIterator.ReadNextAsync())
        {
            // Handle failure scenario. 
            if(!response.IsSuccessStatusCode)
            {
                // Log the response.Diagnostics and handle the error
            }

            // Process the response.Content Stream
        }
    }
}

GetStoredProcedureQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)

ソース:

Scripts.cs

このメソッドは、パラメーター化された値を持つ SQL ステートメントを使用して、コンテナーの下にストアド プロシージャのクエリを作成します。 FeedIterator を返します。 パラメーター化された値を使用した SQL ステートメントの準備の詳細については、「オーバーロード」を参照してください QueryDefinition 。

public abstract Microsoft.Azure.Cosmos.FeedIterator GetStoredProcedureQueryStreamIterator (Microsoft.Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Microsoft.Azure.Cosmos.QueryRequestOptions requestOptions = default);

abstract member GetStoredProcedureQueryStreamIterator : Microsoft.Azure.Cosmos.QueryDefinition * string * Microsoft.Azure.Cosmos.QueryRequestOptions -> Microsoft.Azure.Cosmos.FeedIterator

Public MustOverride Function GetStoredProcedureQueryStreamIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing) As FeedIterator

パラメーター

queryDefinition

QueryDefinition

Cosmos SQL クエリ定義。

continuationToken

String

(省略可能)Azure Cosmos DB サービスの継続トークン。

requestOptions

QueryRequestOptions

(省略可能)項目クエリ要求のオプション。

戻り値

FeedIterator

既存のストアド プロシージャを読み取る反復子。

例

これにより、入力として queryDefinition を使用する sproc のストリーム フィード反復子が作成されます。

Scripts scripts = this.container.Scripts;
string queryText = "SELECT * FROM s where s.id like @testId";
QueryDefinition queryDefinition = new QueryDefinition(queryText);
queryDefinition.WithParameter("@testId", "testSprocId");
using (FeedIterator feedIterator = scripts.GetStoredProcedureQueryStreamIterator(queryDefinition))
{
    while (feedIterator.HasMoreResults)
    {
        // Stream iterator returns a response with status for errors
        using(ResponseMessage response = await feedIterator.ReadNextAsync())
        {
            // Handle failure scenario. 
            if(!response.IsSuccessStatusCode)
            {
                // Log the response.Diagnostics and handle the error
            }

            // Process the response.Content Stream
        }
    }
}