Class WriterProperties

Namespace

ParquetSharp

Assembly

ParquetSharp.dll

Configures options for writing Parquet files.

public sealed class WriterProperties : IDisposable

Inheritance

object

WriterProperties

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CreatedBy

The entity that created the file.

public string CreatedBy { get; }

Property Value

string

DataPageSize

The size of the data pages in bytes.

public long DataPageSize { get; }

Property Value

long

DictionaryIndexEncoding

The Encoding used for dictionary index encoding.

public Encoding DictionaryIndexEncoding { get; }

Property Value

Encoding

DictionaryPageEncoding

The Encoding used for dictionary page encoding.

public Encoding DictionaryPageEncoding { get; }

Property Value

Encoding

DictionaryPagesizeLimit

The maximum dictionary page size in bytes.

public long DictionaryPagesizeLimit { get; }

Property Value

long

FileEncryptionProperties

The FileEncryptionProperties used for writing encrypted files.

public FileEncryptionProperties FileEncryptionProperties { get; }

Property Value

FileEncryptionProperties

MaxRowGroupLength

The maximum number of rows in a row group.

public long MaxRowGroupLength { get; }

Property Value

long

MemoryPool

The memory pool that will be used by allocations in the writer.

public MemoryPool MemoryPool { get; }

Property Value

MemoryPool

PageChecksumEnabled

Whether CRC checksums are written for data pages

public bool PageChecksumEnabled { get; }

Property Value

bool

StoreDecimalAsInteger

Whether decimals with precision between 1 and 18 (inclusive) are stored as integers.

public bool StoreDecimalAsInteger { get; }

Property Value

bool

Version

The version of the Parquet format to write.

public ParquetVersion Version { get; }

Property Value

ParquetVersion

WriteBatchSize

The number of records to batch together when writing.

public long WriteBatchSize { get; }

Property Value

long

WritePageIndex

Whether writing the page index is enabled for any columns

public bool WritePageIndex { get; }

Property Value

bool

Methods

Compression(ColumnPath)

Get the Compression type used for the specified column.

public Compression Compression(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

Compression

The Compression type used for the specified column.

CompressionLevel(ColumnPath)

Get the compression level used for the specified column.

public int CompressionLevel(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

int

The compression level used for the specified column.

DictionaryEnabled(ColumnPath)

Whether dictionary encoding is enabled for the specified column.

public bool DictionaryEnabled(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

bool

Whether dictionary encoding is enabled for the specified column.

Dispose()

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

public void Dispose()

Encoding(ColumnPath)

Get the Encoding used for the specified column.

public Encoding Encoding(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

Encoding

The Encoding used for the specified column.

GetDefaultWriterProperties()

Create a new WriterProperties with default values.

public static WriterProperties GetDefaultWriterProperties()

Returns

WriterProperties

A new WriterProperties object with default values.

MaxStatisticsSize(ColumnPath)

The maximum size of statistics for the specified column.

public ulong MaxStatisticsSize(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

ulong

The maximum size of statistics for the specified column.

SortingColumns()

Gets the columns by which the data is sorted.

public WriterProperties.SortingColumn[] SortingColumns()

Returns

SortingColumn[]

An array of WriterProperties.SortingColumn specifying the sorting order for the file

StatisticsEnabled(ColumnPath)

Whether statistics are enabled for the specified column.

public bool StatisticsEnabled(ColumnPath path)

Parameters

path ColumnPath

The ColumnPath of the column.

Returns

bool

Whether statistics are enabled for the specified column.

WritePageIndexForPath(ColumnPath)

Whether writing the page index is enabled for the specified column

public bool WritePageIndexForPath(ColumnPath path)

Parameters

path ColumnPath

Returns

bool