API Reference ex_arrow v#0.6.0

Apache Arrow support for the BEAM: IPC, Flight, ADBC, and data interchange.

ADBC Connection: open from Database, then create Statements. Delegates to the configured implementation (see :adbc_connection_impl in application config).

Behaviour for ADBC Connection implementations. Used with Mox in tests.

NimblePool-backed ADBC connection pool for ExArrow.

ADBC Database handle: open a database via driver (shared library / env).

Behaviour for ADBC Database implementations. Used with Mox in tests.

A supervised wrapper around ExArrow.ADBC.Database that holds a database handle open for the lifetime of the process and makes it reachable by name.

Convenience helpers for using ExArrow's ADBC APIs together with the adbc package.

ADBC error or diagnostic message.

ADBC Statement: create with new(conn, sql) or new(conn, sql, bind: batch), then execute to get an Arrow stream (record batches). Use set_sql/2 and bind/2 when reusing a statement. Delegates to the configured implementation (see :adbc_statement_impl in application config).

Behaviour for ADBC Statement implementations. Used with Mox in tests.

Arrow array handle (opaque reference to native array).

Arrow C Data Interface (CDI) bridge for ExArrow.

Arrow compute kernels: filter rows, project (select) columns, and sort — all entirely in native memory.

Ergonomic conversion between Explorer DataFrames and Arrow data.

Structured error type for ExArrow operations.

Bridge between ExArrow and Explorer DataFrames.

Arrow field metadata (name, type, and nullability).

Describes an action type supported by a Flight server.

Arrow Flight client: connect to a Flight server and exchange Arrow data.

Behaviour for Arrow Flight client implementations. Allows swapping the real client for a mock in tests (e.g. with Mox).

Metadata describing a named Arrow dataset served by a Flight server.

Arrow Flight server: multi-dataset routing server with optional TLS.

Arrow Flight SQL client for ExArrow.

Arrow Flight SQL client for executing SQL queries against a remote server.

Structured error type for Flight SQL operations.

Materialized result from a Flight SQL query.

An opaque handle to a server-side prepared statement.

IPC file format reader: random access to schema, batch count, and batches by index.

IPC stream/file reader: read Arrow data from binary or file path.

IPC stream/file writer: write Arrow record batches to binary or file.

Bridge between ExArrow and Nx tensors.

Parquet file reader: open a .parquet file or an in-memory binary and receive an ExArrow.Stream that yields record batches.

Parquet file writer: serialise Arrow record batches to a .parquet file or to an in-memory binary.

Arrow record batch handle (opaque reference to native record batch).

Arrow schema handle (opaque reference to native schema).

Bidirectional mapping between Arrow type representations and external type systems.

Opaque handle to a native Arrow record-batch stream.

An Arrow table: a collection of record batches with a shared schema.

Runs the same steps as the CI workflow: deps.get, compile --warnings-as-errors, test, docs.