Parquex.Dataset.Stream (parquex v0.3.0)

A pull-based, prefix-pruned stream across dataset parts.

Summary

t()

close(stream)

Closes the active file reader. This operation is idempotent.

schema(stream)

Returns the projected output schema without listing or opening objects.

stats(stream)

Returns bounded-cardinality planning and traversal counts without object keys.

@opaque t()

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

Closes the active file reader. This operation is idempotent.

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

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

Returns the projected output schema without listing or opening objects.

@spec stats(t()) :: {:ok, map()}

Returns bounded-cardinality planning and traversal counts without object keys.