QuackDB (quackdb v0.3.0)

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

Types

insert_column()

insert_row()

start_option()

Functions

child_spec(options)

column_batches(connection, statement, params \\ [], options \\ [])

Streams query results as column-oriented batches.

columnar(connection, statement, params \\ [], options \\ [])

Runs a query and returns a QuackDB.Columns struct.

columnar!(connection, statement, params \\ [], options \\ [])

columnar_batches(connection, statement, params \\ [], options \\ [])

Streams query results as QuackDB.Columns batches.

columns(connection, statement, params \\ [], options \\ [])

Runs a query and returns its result as a column-oriented map.

columns!(connection, statement, params \\ [], options \\ [])

insert_columns(connection, table, columns, options \\ [])

Appends column-oriented values to a DuckDB table through Quack's native append protocol.

insert_columns!(connection, table, columns, options \\ [])

insert_rows(connection, table, rows, options \\ [])

insert_rows!(connection, table, rows, options \\ [])

maps(connection, statement, params \\ [], options \\ [])

ping(connection, options \\ [])

prepare(connection, statement, options \\ [])

prepare_execute(connection, statement, params \\ [], options \\ [])

query(connection, statement, params \\ [], options \\ [])

query!(connection, statement, params \\ [], options \\ [])

rows(connection, statement, params \\ [], options \\ [])

start_link(options)

stream(connection, statement, params \\ [], options \\ [])

Types

insert_column()

@type insert_column() :: {atom() | String.t(), [term()]}

insert_row()

@type insert_row() :: map() | Keyword.t()

start_option()

@type start_option() ::
  {:uri, String.t()}
  | {:token, String.t()}
  | {:name, GenServer.name()}
  | {:connect_timeout, timeout()}
  | {:receive_timeout, timeout()}
  | {:shutdown_timeout, timeout()}
  | {:mint_options, keyword()}

Functions

child_spec(options)

@spec child_spec([start_option()]) :: Supervisor.child_spec()

column_batches(connection, statement, params \\ [], options \\ [])

@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.

columnar(connection, statement, params \\ [], options \\ [])

@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.

columnar!(connection, statement, params \\ [], options \\ [])

@spec columnar!(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  QuackDB.Columns.t()

columnar_batches(connection, statement, params \\ [], options \\ [])

@spec columnar_batches(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  Enumerable.t()

Streams query results as QuackDB.Columns batches.

columns(connection, statement, params \\ [], options \\ [])

@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.

columns!(connection, statement, params \\ [], options \\ [])

@spec columns!(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: %{
  required(String.t()) => [term()]
}

insert_columns(connection, table, columns, options \\ [])

@spec insert_columns(
  DBConnection.conn(),
  String.t() | atom(),
  [insert_column()],
  Keyword.t()
) ::
  {:ok, QuackDB.Result.t()} | {:error, Exception.t()}

Appends column-oriented values to a DuckDB table through Quack's native append protocol.

Column values are provided as {name, values} pairs. All columns must have the same row count. Pass :columns with type specs when values are empty or contain only nils.

insert_columns!(connection, table, columns, options \\ [])

@spec insert_columns!(
  DBConnection.conn(),
  String.t() | atom(),
  [insert_column()],
  Keyword.t()
) ::
  QuackDB.Result.t()

insert_rows(connection, table, rows, options \\ [])

@spec insert_rows(
  DBConnection.conn(),
  String.t() | atom(),
  [insert_row()],
  Keyword.t()
) ::
  {:ok, QuackDB.Result.t()} | {:error, Exception.t()}

insert_rows!(connection, table, rows, options \\ [])

@spec insert_rows!(
  DBConnection.conn(),
  String.t() | atom(),
  [insert_row()],
  Keyword.t()
) ::
  QuackDB.Result.t()

maps(connection, statement, params \\ [], options \\ [])

@spec maps(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()

ping(connection, options \\ [])

@spec ping(DBConnection.conn(), Keyword.t()) :: :ok | {:error, Exception.t()}

prepare(connection, statement, options \\ [])

@spec prepare(DBConnection.conn(), iodata(), Keyword.t()) ::
  {:ok, QuackDB.Query.t()} | {:error, Exception.t()}

prepare_execute(connection, statement, params \\ [], options \\ [])

@spec prepare_execute(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  {:ok, QuackDB.Query.t(), QuackDB.Result.t()} | {:error, Exception.t()}

query(connection, statement, params \\ [], options \\ [])

@spec query(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  {:ok, QuackDB.Result.t()} | {:error, Exception.t()}

query!(connection, statement, params \\ [], options \\ [])

@spec query!(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  QuackDB.Result.t()

rows(connection, statement, params \\ [], options \\ [])

@spec rows(DBConnection.conn(), iodata(), [term()], Keyword.t()) :: Enumerable.t()

start_link(options)

@spec start_link([start_option()]) :: GenServer.on_start()

stream(connection, statement, params \\ [], options \\ [])

@spec stream(DBConnection.conn(), iodata(), [term()], Keyword.t()) ::
  QuackDB.Stream.t()