Remote DuckDB Quack protocol client.
The public API is backed by DBConnection so it can grow into an Ecto adapter
without changing the lower-level protocol codec.
Summary
Functions
Streams query results as column-oriented batches.
Runs a query and returns a QuackDB.Columns struct.
Streams query results as QuackDB.Columns batches.
Runs a query and returns its result as a column-oriented map.
Types
@type start_option() :: {:uri, String.t()} | {:token, String.t()} | {:name, GenServer.name()}
Functions
@spec child_spec([start_option()]) :: Supervisor.child_spec()
@spec column_batches(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()
Streams query results as column-oriented batches.
Each item is a map from disambiguated column names to the values in that fetch
batch. This keeps large analytical results vector-shaped without materializing
the whole result set. Prefer columnar_batches/4 when you also need batch
metadata.
@spec columnar(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: {:ok, QuackDB.Columns.t()} | {:error, Exception.t()}
Runs a query and returns a QuackDB.Columns struct.
This preserves column order, original names, row count, and result metadata in addition to the column vectors.
@spec columnar!(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: QuackDB.Columns.t()
@spec columnar_batches(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()
Streams query results as QuackDB.Columns batches.
@spec columns(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: {:ok, %{required(String.t()) => [term()]}} | {:error, Exception.t()}
Runs a query and returns its result as a column-oriented map.
Duplicate column names are disambiguated with suffixes such as _2 and _3.
Prefer columnar/4 when you also need column order and result metadata.
@spec maps(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()
@spec ping(DBConnection.conn(), Keyword.t()) :: :ok | {:error, Exception.t()}
@spec prepare(DBConnection.conn(), iodata(), Keyword.t()) :: {:ok, QuackDB.Query.t()} | {:error, Exception.t()}
@spec prepare_execute(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: {:ok, QuackDB.Query.t(), QuackDB.Result.t()} | {:error, Exception.t()}
@spec query(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: {:ok, QuackDB.Result.t()} | {:error, Exception.t()}
@spec query!(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: QuackDB.Result.t()
@spec rows(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()
@spec start_link([start_option()]) :: GenServer.on_start()
@spec stream(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: QuackDB.Stream.t()