Class ParquetFileReader

Namespace

ParquetSharp

Assembly

ParquetSharp.dll

Opens and reads Parquet files.

public sealed class ParquetFileReader : IDisposable

Inheritance

object

ParquetFileReader

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ParquetFileReader(RandomAccessFile)

Create a new ParquetFileReader for reading from a specified RandomAccessFile

public ParquetFileReader(RandomAccessFile randomAccessFile)

Parameters

randomAccessFile RandomAccessFile

The file to read

ParquetFileReader(RandomAccessFile, ReaderProperties?)

Create a new ParquetFileReader for reading from a specified RandomAccessFile

public ParquetFileReader(RandomAccessFile randomAccessFile, ReaderProperties? readerProperties)

Parameters

randomAccessFile RandomAccessFile

The file to read

readerProperties ReaderProperties

The ReaderProperties to use

Exceptions

ArgumentNullException

Thrown if the file or its handle are null

ParquetFileReader(Stream, ReaderProperties?, bool)

Create a new ParquetFileReader for reading from a .NET stream

public ParquetFileReader(Stream stream, ReaderProperties? readerProperties, bool leaveOpen = false)

Parameters

stream Stream

The stream to read

readerProperties ReaderProperties

Configures the reader properties

leaveOpen bool

Whether to keep the stream open after the reader is closed

ParquetFileReader(Stream, bool)

Create a new ParquetFileReader for reading from a .NET stream

public ParquetFileReader(Stream stream, bool leaveOpen = false)

Parameters

stream Stream

The stream to read

leaveOpen bool

Whether to keep the stream open after the reader is closed

ParquetFileReader(string)

Create a new ParquetFileReader for reading from a file at the specified path

public ParquetFileReader(string path)

Parameters

path string

Path to the Parquet file

ParquetFileReader(string, ReaderProperties?)

Create a new ParquetFileReader for reading from a file at the specified path

public ParquetFileReader(string path, ReaderProperties? readerProperties)

Parameters

path string

Path to the Parquet file

readerProperties ReaderProperties

A ReaderProperties object that configures the reader

Exceptions

ArgumentNullException

Thrown if the path is null

Properties

FileMetaData

Metadata associated with the Parquet file.

public FileMetaData FileMetaData { get; }

Property Value

FileMetaData

LogicalReadConverterFactory

The LogicalReadConverterFactory for reading custom types.

public LogicalReadConverterFactory LogicalReadConverterFactory { get; set; }

Property Value

LogicalReadConverterFactory

LogicalTypeFactory

The LogicalTypeFactory for handling custom types.

public LogicalTypeFactory LogicalTypeFactory { get; set; }

Property Value

LogicalTypeFactory

Methods

Close()

public void Close()

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

RowGroup(int)

Get a RowGroupReader for the specified row group index.

public RowGroupReader RowGroup(int i)

Parameters

i int

The row group index

Returns

RowGroupReader

A RowGroupReader for the specified row group index