ExArrow.ADBC.Statement (ex_arrow v0.4.0)

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

Summary

Types

t()

Functions

bind(stmt, batch)

Binds a record batch to the statement (e.g. for prepared statements or bulk insert). Not all drivers support binding; returns {:error, message} if unsupported.

execute(stmt)

Executes the statement and returns a stream of record batches. Use ExArrow.Stream.schema/1 and ExArrow.Stream.next/1 to read the result.

new(conn)

Creates a new statement from a connection.

new(conn, sql)

new(conn, sql, opts)

set_sql(stmt, sql)

Sets the SQL for this statement (e.g. when creating with new/1 for reuse).

Types

t()

@opaque t()

Functions

bind(stmt, batch)

@spec bind(t(), ExArrow.RecordBatch.t()) :: :ok | {:error, term()}

Binds a record batch to the statement (e.g. for prepared statements or bulk insert). Not all drivers support binding; returns {:error, message} if unsupported.

execute(stmt)

@spec execute(t()) :: {:ok, ExArrow.Stream.t()} | {:error, term()}

Executes the statement and returns a stream of record batches. Use ExArrow.Stream.schema/1 and ExArrow.Stream.next/1 to read the result.

new(conn)

@spec new(ExArrow.ADBC.Connection.t()) :: {:ok, t()} | {:error, term()}

Creates a new statement from a connection.

Optionally pass SQL and/or an initial bind as a record batch:

{:ok, stmt} = Statement.new(conn, "SELECT 1 AS n")
{:ok, stmt} = Statement.new(conn, "INSERT INTO t SELECT * FROM ?", bind: record_batch)

Use bind/2 to rebind after creation.

new(conn, sql)

@spec new(ExArrow.ADBC.Connection.t(), String.t()) :: {:ok, t()} | {:error, term()}

new(conn, sql, opts)

@spec new(ExArrow.ADBC.Connection.t(), String.t(), keyword()) ::
  {:ok, t()} | {:error, term()}

set_sql(stmt, sql)

@spec set_sql(t(), String.t()) :: :ok | {:error, term()}

Sets the SQL for this statement (e.g. when creating with new/1 for reuse).