Parquex.Stream (parquex v0.3.0)

View Source

A single-pass, pull-based stream of bounded Parquex.Batch values.

Each downstream demand calls the native reader once. Halting enumeration or a consumer exception runs the stream finalizer and closes native state.

Summary

Functions

Closes and cancels the native reader. This operation is idempotent.

Returns the projected schema without advancing the stream.

Returns deterministic native buffering and range-read counters.

Types

t()

@opaque t()

Functions

close(stream)

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

Closes and cancels the native reader. This operation is idempotent.

schema(stream)

@spec schema(t()) :: Parquex.Schema.t()

Returns the projected schema without advancing the stream.

stats(stream)

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

Returns deterministic native buffering and range-read counters.