API Reference F3 v#0.1.0

Copy Markdown

Modules

F3

Experimental Elixir API for the F3 columnar file format.

Columnar batch.

XXH64 checksums for chunk bytes.

One columnar vector owned by Elixir.

Decodes one CASCADE encoding unit into an owned F3.Column.

Calls the dirty-CPU NIF for one encoding unit.

Chooses a decoder for one encoding unit.

Error returned by the public F3 API.

Elixir decoder registered for one footer encoding.

Open file handle.

Bounded reader for the FlatBuffers tables this library needs.

Decodes an F3 footer into F3.Metadata.

Pinned wire-format constants from upstream F3.

Operating-system calls used by F3.IO.Local.

F3.IO.FileSystem implementation that calls File and :file.

HTTP byte source.

Local filesystem source.

In-memory byte source.

Positioned byte source.

Text and JSON rendering of F3.Metadata.

Stitches physical columns into logical fields.

File metadata from the postscript, the FlatBuffers footer, and the out-of-band column metadata those tables point at.

Optional native decoder.

The 32-byte tail of an F3 file.

Projection, row-group selection, and batching.

Bounded ETS table of F3.Extension modules.

One row group, with the column chunks the footer points at.

Logical Arrow schema read from an F3 footer.

Loads one embedded Wasm module after the caller has opted in.

Local F3 writer.

Mix Tasks

Prints metadata for one F3 file.