Class ArrowFileReader

Namespace

Apache.Arrow.Ipc

Assembly

Apache.Arrow.dll

Implements an ArrowStreamReader that can read Arrow files.

public class ArrowFileReader : ArrowStreamReader, IArrowArrayStream, IArrowReader, IDisposable

Inheritance

object

ArrowStreamReader

ArrowFileReader

Implements

IArrowArrayStream

IArrowReader

IDisposable

Inherited Members

ArrowStreamReader.Schema

ArrowStreamReader.Dispose()

ArrowStreamReader.Dispose(bool)

ArrowStreamReader.GetSchema(CancellationToken)

ArrowStreamReader.ReadNextRecordBatchAsync(CancellationToken)

ArrowStreamReader.ReadNextRecordBatch()

ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken)

ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ArrowFileReader(ArrowContext, Stream, bool)

public ArrowFileReader(ArrowContext context, Stream stream, bool leaveOpen = false)

Parameters

context ArrowContext

stream Stream

leaveOpen bool

ArrowFileReader(Stream)

public ArrowFileReader(Stream stream)

Parameters

stream Stream

ArrowFileReader(Stream, ICompressionCodecFactory)

public ArrowFileReader(Stream stream, ICompressionCodecFactory compressionCodecFactory)

Parameters

stream Stream

compressionCodecFactory ICompressionCodecFactory

ArrowFileReader(Stream, MemoryAllocator)

public ArrowFileReader(Stream stream, MemoryAllocator allocator)

Parameters

stream Stream

allocator MemoryAllocator

ArrowFileReader(Stream, MemoryAllocator, ICompressionCodecFactory)

public ArrowFileReader(Stream stream, MemoryAllocator allocator, ICompressionCodecFactory compressionCodecFactory)

Parameters

stream Stream

allocator MemoryAllocator

compressionCodecFactory ICompressionCodecFactory

ArrowFileReader(Stream, MemoryAllocator, ICompressionCodecFactory, bool)

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

Parameters

stream Stream

allocator MemoryAllocator

compressionCodecFactory ICompressionCodecFactory

leaveOpen bool

ArrowFileReader(Stream, MemoryAllocator, bool)

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

Parameters

stream Stream

allocator MemoryAllocator

leaveOpen bool

ArrowFileReader(Stream, bool)

public ArrowFileReader(Stream stream, bool leaveOpen)

Parameters

stream Stream

leaveOpen bool

Properties

IsFileValid

public bool IsFileValid { get; }

Property Value

bool

Methods

FromFile(string)

public static ArrowFileReader FromFile(string filename)

Parameters

filename string

Returns

ArrowFileReader

ReadRecordBatchAsync(int, CancellationToken)

public ValueTask<RecordBatch> ReadRecordBatchAsync(int index, CancellationToken cancellationToken = default)

Parameters

index int

cancellationToken CancellationToken

Returns

ValueTask<RecordBatch>

ReadRecordBatchWithCustomMetadataAsync(int, CancellationToken)

Reads the record batch at the given index together with the custom metadata on its IPC Message, which is null if the message carried none.

public ValueTask<RecordBatchWithMetadata> ReadRecordBatchWithCustomMetadataAsync(int index, CancellationToken cancellationToken = default)

Parameters

index int

cancellationToken CancellationToken

Returns

ValueTask<RecordBatchWithMetadata>

RecordBatchCountAsync()

public ValueTask<int> RecordBatchCountAsync()

Returns

ValueTask<int>