CosmosScripts.GetUserDefinedFunctionQueryStreamIterator Method

Definition

Namespace:

Azure.Cosmos.Scripts

Assembly:

Azure.Cosmos.dll

Package:

Azure.Cosmos v4.0.0-preview3

Overloads

GetUserDefinedFunctionQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)	This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.
GetUserDefinedFunctionQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)	This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

GetUserDefinedFunctionQueryStreamIterator(QueryDefinition, String, QueryRequestOptions, CancellationToken)

This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

public abstract System.Collections.Generic.IAsyncEnumerable<Azure.Response> GetUserDefinedFunctionQueryStreamIterator (Azure.Cosmos.QueryDefinition queryDefinition, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUserDefinedFunctionQueryStreamIterator : Azure.Cosmos.QueryDefinition * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Response>

Public MustOverride Function GetUserDefinedFunctionQueryStreamIterator (queryDefinition As QueryDefinition, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Response)

Parameters

queryDefinition

QueryDefinition

The cosmos SQL query definition.

continuationToken

String

(Optional) The continuation token in the Azure Cosmos DB service.

requestOptions

QueryRequestOptions

(Optional) The options for the item query request QueryRequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

IAsyncEnumerable<Response>

An iterator to read through the existing stored procedures.

Examples

This create the stream feed iterator for UDF with queryDefinition as input.

CosmosScripts scripts = this.container.Scripts;
string queryText = "SELECT * FROM u where u.id like @testId";
QueryDefinition queryDefinition = new QueryDefinition(queryText);
queryDefinition.WithParameter("@testId", "testUdfId");
IAsyncEnumerable<Response> iter = this.scripts.GetUserDefinedFunctionQueryStreamIterator(queryDefinition);

GetUserDefinedFunctionQueryStreamIterator(String, String, QueryRequestOptions, CancellationToken)

This method creates a query for user defined functions under a container using a SQL statement. It returns a FeedIterator. For more information on preparing SQL statements with parameterized values, please see QueryDefinition overload.

public abstract System.Collections.Generic.IAsyncEnumerable<Azure.Response> GetUserDefinedFunctionQueryStreamIterator (string queryText = default, string continuationToken = default, Azure.Cosmos.QueryRequestOptions requestOptions = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetUserDefinedFunctionQueryStreamIterator : string * string * Azure.Cosmos.QueryRequestOptions * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.Response>

Public MustOverride Function GetUserDefinedFunctionQueryStreamIterator (Optional queryText As String = Nothing, Optional continuationToken As String = Nothing, Optional requestOptions As QueryRequestOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of Response)

Parameters

queryText

String

The cosmos SQL query text.

continuationToken

String

(Optional) The continuation token in the Azure Cosmos DB service.

requestOptions

QueryRequestOptions

(Optional) The options for the item query request QueryRequestOptions

cancellationToken

CancellationToken

(Optional) CancellationToken representing request cancellation.

Returns

IAsyncEnumerable<Response>

An iterator to read through the existing stored procedures.

Examples

This create the stream feed iterator for UDF with queryText as input.

CosmosScripts scripts = this.container.Scripts;
QueryDefinition queryDefinition = new QueryDefinition("SELECT * FROM u where u.id like '%testId%'");
IAsyncEnumerable<Response> iter = this.scripts.GetUserDefinedFunctionQueryStreamIterator(queryDefinition);