Gemstone Data Library
Show/Hide TOC

# AdoDataConnectionRetrieveDataAsAsyncEnumerable(DataTable, CommandBehavior, Int32, String, CancellationToken, Object) Method

Executes the SQL statement using Connection using a DbDataReader and returns data rows based on the provided schema as an asynchronous enumerable.

## Definition

Namespace: Gemstone.Data
Assembly: Gemstone.Data (in Gemstone.Data.dll) Version: 1.0.154 -- Release Build+ee2a56b417c3f3a6bb5e8cea81b3ecb110342bf0
C#
View Source Request Example

    public IAsyncEnumerable<DataRow> RetrieveDataAsAsyncEnumerable(
    	DataTable schema,
    	CommandBehavior behavior,
    	int timeout,
    	string sqlFormat,
    	CancellationToken cancellationToken,
    	params Object?[] parameters
    )

VB
View Source Request Example

    Public Function RetrieveDataAsAsyncEnumerable (
    	schema As DataTable,
    	behavior As CommandBehavior,
    	timeout As Integer,
    	sqlFormat As String,
    	cancellationToken As CancellationToken,
    	ParamArray parameters As Object()
    ) As IAsyncEnumerable(Of DataRow)

C++
View Source Request Example

    public:
    IAsyncEnumerable<DataRow^>^ RetrieveDataAsAsyncEnumerable(
    	DataTable^ schema,
    	CommandBehavior behavior,
    	int timeout,
    	String^ sqlFormat,
    	CancellationToken cancellationToken,
    	... array<Object^>^ parameters
    )

JavaScript
View Source Request Example

    function RetrieveDataAsAsyncEnumerable(schema, behavior, timeout, sqlFormat, cancellationToken, ... parameters);

#### Parameters

schema DataTable
  DataTable that defines the schema for the data rows.
behavior CommandBehavior
  One of the CommandBehavior values.
timeout Int32
  The time in seconds to wait for the SQL statement to execute.
sqlFormat String
  Format string for the SQL statement to be executed.
cancellationToken CancellationToken
  Propagates notification that operations should be canceled.
parameters Object
  The parameter values to be used to fill in DbParameter parameters.

#### Return Value

IAsyncEnumerable DataRow
An asynchronous enumerable of DataRow objects.

## Remarks

If provided schema does not match the schema of the result set based on sqlFormat, the results may be unpredictable or method call may fail.

## See Also

#### Reference

AdoDataConnection Class
RetrieveDataAsAsyncEnumerable Overload
Gemstone.Data Namespace