Class FlightRecordBatchStreamWriter

Namespace

Apache.Arrow.Flight

Assembly

Apache.Arrow.Flight.dll

public abstract class FlightRecordBatchStreamWriter : IAsyncStreamWriter<RecordBatch>, IDisposable

Inheritance

object

FlightRecordBatchStreamWriter

Implements

IAsyncStreamWriter<RecordBatch>

IDisposable

Derived

FlightClientRecordBatchStreamWriter

FlightServerRecordBatchStreamWriter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

WriteOptions

Write options that will be used for the next write. If null, default options will be used. Once set, this property maintains its value across subsequent writes.

public WriteOptions WriteOptions { get; set; }

Property Value

WriteOptions

Methods

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

SetupStream(Schema)

Configure the data stream to write to.

public Task SetupStream(Schema schema)

Parameters

schema Schema

The schema of data to be written to this stream

Returns

Task

Remarks

The stream will be set up automatically when writing a RecordBatch if required, but calling this method before writing any data allows handling empty streams.

WriteAsync(RecordBatch)

Writes a message asynchronously. Only one write can be pending at a time.

public Task WriteAsync(RecordBatch message)

Parameters

message RecordBatch

The message to be written. Cannot be null.

Returns

Task

WriteAsync(RecordBatch, ByteString)

public Task WriteAsync(RecordBatch message, ByteString applicationMetadata)

Parameters

message RecordBatch

applicationMetadata ByteString

Returns

Task