Parquex.Dataset.Writer (parquex v0.3.0)

View Source

A foreground, owner-bound writer for bounded time-partitioned Parquet parts.

Summary

Functions

Returns a specification to start this module under a supervisor.

Types

t()

@opaque t()

Functions

cancel(writer)

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

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

close(writer)

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

open(dataset, options \\ [])

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

write(writer, input)

@spec write(t(), Parquex.Batch.t() | map() | [map()]) ::
  :ok | {:error, Parquex.Error.t()}