Class FlightRecordBatchStreamReader

Namespace

Apache.Arrow.Flight

Assembly

Apache.Arrow.Flight.dll

Stream of record batches

Use MoveNext() and Current to iterate over the batches. There are also gRPC helper functions such as ToListAsync() etc.

public abstract class FlightRecordBatchStreamReader : IAsyncStreamReader<RecordBatch>, IAsyncEnumerable<RecordBatch>, IDisposable

Inheritance

object

FlightRecordBatchStreamReader

Implements

IAsyncStreamReader<RecordBatch>

IAsyncEnumerable<RecordBatch>

IDisposable

Derived

FlightClientRecordBatchStreamReader

FlightServerRecordBatchStreamReader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApplicationMetadata

Get the application metadata from the latest received record batch

public IReadOnlyList<ByteString> ApplicationMetadata { get; }

Property Value

IReadOnlyList<ByteString>

Current

Gets the current element in the iteration.

public RecordBatch Current { get; }

Property Value

RecordBatch

Schema

public ValueTask<Schema> Schema { get; }

Property Value

ValueTask<Schema>

Methods

Dispose()

public void Dispose()

GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

public IAsyncEnumerator<RecordBatch> GetAsyncEnumerator(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

A CancellationToken that may be used to cancel the asynchronous iteration.

Returns

IAsyncEnumerator<RecordBatch>

An enumerator that can be used to iterate asynchronously through the collection.

MoveNext(CancellationToken)

Advances the reader to the next element in the sequence, returning the result asynchronously.

public Task<bool> MoveNext(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Cancellation token that can be used to cancel the operation.

Returns

Task<bool>

Task containing the result of the operation: true if the reader was successfully advanced to the next element; false if the reader has passed the end of the sequence.