Class BatchQuery<TResult>

Namespace

NextORM.Core

Assembly

nextorm.core.dll

Terminal of a batch: materialises the rows of the batch's result-bearing query. The whole batch — the preceding statements and this query — executes as one round trip.

public sealed class BatchQuery<TResult>

Type Parameters

TResult

The projected row type.

Inheritance

object

BatchQuery<TResult>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

EntityBuilderExtensions.AsEntityBuilder<T>(object?)

Methods

ToAsyncEnumerable(CancellationToken)

Streams the batch's result rows. The underlying reader stays open for the whole batch, so the batch executes when enumeration starts and its connection is held until enumeration completes.

public IAsyncEnumerable<TResult> ToAsyncEnumerable(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels enumeration.

Returns

IAsyncEnumerable<TResult>

An asynchronous sequence over the result rows.

Exceptions

NotSupportedException

The dialect cannot express the batch or one of its statements.

ToList()

Executes the batch and materialises the result rows.

public List<TResult> ToList()

Returns

List<TResult>

The result rows, in result-set order.

Exceptions

NotSupportedException

The dialect cannot express the batch or one of its statements.

ToListAsync(CancellationToken)

Asynchronously executes the batch and materialises the result rows.

public Task<List<TResult>> ToListAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancels execution.

Returns

Task<List<TResult>>

A task producing the result rows, in result-set order.

Exceptions

NotSupportedException

The dialect cannot express the batch or one of its statements.

ToSql()

Renders the whole batch (statements joined with ;) without executing it.

public string ToSql()

Returns

string

The rendered SQL text.

Exceptions

NotSupportedException

The dialect cannot express the batch or one of its statements.