Class ArrowStreamReader

Namespace

Apache.Arrow.Ipc

Assembly

Apache.Arrow.dll

Represents a reader that can read Arrow streams.

public class ArrowStreamReader : IArrowArrayStream, IArrowReader, IDisposable

Inheritance

object

ArrowStreamReader

Implements

IArrowArrayStream

IArrowReader

IDisposable

Derived

ArrowFileReader

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArrowStreamReader(Stream)

public ArrowStreamReader(Stream stream)

Parameters

stream Stream

ArrowStreamReader(Stream, ICompressionCodecFactory)

public ArrowStreamReader(Stream stream, ICompressionCodecFactory compressionCodecFactory)

Parameters

stream Stream

compressionCodecFactory ICompressionCodecFactory

ArrowStreamReader(Stream, ICompressionCodecFactory, bool)

public ArrowStreamReader(Stream stream, ICompressionCodecFactory compressionCodecFactory, bool leaveOpen)

Parameters

stream Stream

compressionCodecFactory ICompressionCodecFactory

leaveOpen bool

ArrowStreamReader(Stream, MemoryAllocator)

public ArrowStreamReader(Stream stream, MemoryAllocator allocator)

Parameters

stream Stream

allocator MemoryAllocator

ArrowStreamReader(Stream, MemoryAllocator, ICompressionCodecFactory, bool)

public ArrowStreamReader(Stream stream, MemoryAllocator allocator, ICompressionCodecFactory compressionCodecFactory, bool leaveOpen)

Parameters

stream Stream

allocator MemoryAllocator

compressionCodecFactory ICompressionCodecFactory

leaveOpen bool

ArrowStreamReader(Stream, MemoryAllocator, bool)

public ArrowStreamReader(Stream stream, MemoryAllocator allocator, bool leaveOpen)

Parameters

stream Stream

allocator MemoryAllocator

leaveOpen bool

ArrowStreamReader(Stream, bool)

public ArrowStreamReader(Stream stream, bool leaveOpen)

Parameters

stream Stream

leaveOpen bool

ArrowStreamReader(ReadOnlyMemory<byte>)

public ArrowStreamReader(ReadOnlyMemory<byte> buffer)

Parameters

buffer ReadOnlyMemory<byte>

ArrowStreamReader(ReadOnlyMemory<byte>, ICompressionCodecFactory)

public ArrowStreamReader(ReadOnlyMemory<byte> buffer, ICompressionCodecFactory compressionCodecFactory)

Parameters

buffer ReadOnlyMemory<byte>

compressionCodecFactory ICompressionCodecFactory

Properties

Schema

May block if the schema hasn't yet been read. To avoid blocking, use GetSchemaAsync.

public Schema Schema { get; }

Property Value

Schema

Methods

Dispose()

public void Dispose()

Dispose(bool)

protected virtual void Dispose(bool disposing)

Parameters

disposing bool

GetSchema(CancellationToken)

public ValueTask<Schema> GetSchema(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<Schema>

ReadNextRecordBatch()

public RecordBatch ReadNextRecordBatch()

Returns

RecordBatch

ReadNextRecordBatchAsync(CancellationToken)

public ValueTask<RecordBatch> ReadNextRecordBatchAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask<RecordBatch>