Class ParquetWriter

Namespace

Plank.Writing

Assembly

Plank.dll

public sealed class ParquetWriter : IDisposable

Inheritance

object

ParquetWriter

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

RowApiMaxParallelism

public uint RowApiMaxParallelism { get; }

Property Value

uint

Methods

CloseFile()

public void CloseFile()

CreateSerializedColumn<T>(LeafColumn)

public SerializedColumn<T> CreateSerializedColumn<T>(LeafColumn column)

Parameters

column LeafColumn

Returns

SerializedColumn<T>

Type Parameters

T

Dispose()

Releases the writer's pooled buffers and its destination.

public void Dispose()

Remarks

Disposing does not finish the file — call CloseFile() for that. A parquet file is only valid once its footer has been written, and committing one implicitly here would turn a failure part-way through writing into a truncated file that still looks closed. Dispose is the cleanup path: it makes using var writer = ... release buffers and close the destination even when an exception escapes before CloseFile(). It is safe to call after CloseFile(), and more than once.

Reset(IParquetWriteSource)

Starts a new file on a caller-owned destination while retaining the writer's reusable buffers.

public void Reset(IParquetWriteSource destination)

Parameters

destination IParquetWriteSource

Remarks

The writer calls Close() when it finishes with a destination, but never calls Dispose() on a caller-provided destination.

Reset(Stream)

Starts a new file on a stream while retaining the writer's reusable buffers.

public void Reset(Stream stream)

Parameters

stream Stream

Remarks

The writer takes ownership of stream. It closes the current stream before switching to a different one, and closes the active stream when the file is finished or the writer is disposed.

StartRowGroup()

public RowGroupWriter StartRowGroup()

Returns

RowGroupWriter