Table of Contents

Class ArrowStreamWriter

Namespace
Apache.Arrow.Ipc
Assembly
Apache.Arrow.dll
public class ArrowStreamWriter : IDisposable
Inheritance
ArrowStreamWriter
Implements
Derived
Inherited Members

Constructors

ArrowStreamWriter(Stream, Schema)

public ArrowStreamWriter(Stream baseStream, Schema schema)

Parameters

baseStream Stream
schema Schema

ArrowStreamWriter(Stream, Schema, bool)

public ArrowStreamWriter(Stream baseStream, Schema schema, bool leaveOpen)

Parameters

baseStream Stream
schema Schema
leaveOpen bool

ArrowStreamWriter(Stream, Schema, bool, IpcOptions)

public ArrowStreamWriter(Stream baseStream, Schema schema, bool leaveOpen, IpcOptions options)

Parameters

baseStream Stream
schema Schema
leaveOpen bool
options IpcOptions

ArrowStreamWriter(Stream, Schema, bool, IpcOptions, MemoryAllocator)

public ArrowStreamWriter(Stream baseStream, Schema schema, bool leaveOpen, IpcOptions options, MemoryAllocator allocator)

Parameters

baseStream Stream
schema Schema
leaveOpen bool
options IpcOptions
allocator MemoryAllocator

Properties

BaseStream

protected Stream BaseStream { get; }

Property Value

Stream

Buffers

protected ArrayPool<byte> Buffers { get; }

Property Value

ArrayPool<byte>

HasWrittenSchema

protected bool HasWrittenSchema { get; set; }

Property Value

bool

Schema

protected Schema Schema { get; }

Property Value

Schema

Methods

CalculatePadding(long, int)

protected int CalculatePadding(long offset, int alignment = 8)

Parameters

offset long
alignment int

Returns

int

Dispose()

public virtual void Dispose()

WriteEnd()

public void WriteEnd()

WriteEndAsync(CancellationToken)

public Task WriteEndAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task

WriteRecordBatch(RecordBatch)

public virtual void WriteRecordBatch(RecordBatch recordBatch)

Parameters

recordBatch RecordBatch

WriteRecordBatchAsync(RecordBatch, CancellationToken)

public virtual Task WriteRecordBatchAsync(RecordBatch recordBatch, CancellationToken cancellationToken = default)

Parameters

recordBatch RecordBatch
cancellationToken CancellationToken

Returns

Task

WriteStart()

public void WriteStart()

WriteStartAsync(CancellationToken)

public Task WriteStartAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task