Parquex.Writer (parquex v0.3.0)

View Source

An owned, incremental writer for one Parquet file.

Summary

Types

t()

Functions

cancel(writer)
close(writer)
open(store, key, schema, options \\ [])
stats(writer)
write_batch(writer, batch)

Types

t()

@opaque t()

Functions

cancel(writer)

@spec cancel(t()) :: :ok | {:error, Parquex.Error.t()}

close(writer)

@spec close(t()) :: {:ok, Parquex.Store.Metadata.t()} | {:error, Parquex.Error.t()}

open(store, key, schema, options \\ [])

@spec open(Parquex.Store.t(), String.t(), Parquex.Schema.t(), keyword()) ::
  {:ok, t()} | {:error, Parquex.Error.t()}

stats(writer)

@spec stats(t()) :: {:ok, map()} | {:error, Parquex.Error.t()}

write_batch(writer, batch)

@spec write_batch(t(), Parquex.Batch.t()) :: :ok | {:error, Parquex.Error.t()}