Adbc.Result (adbc v0.8.0)

View Source

A struct returned as result from queries.

It has two fields:

  • :data - a list of Adbc.Column. The Adbc.Column may not yet have been materialized

  • :num_rows - the number of rows returned, if returned by the database

Summary

Types

t()

Functions

materialize(result)

materialize/1 converts the result set's data from reference type to regular Elixir terms.

to_map(result)

Returns a map of columns as a result.

Types

t()

@type t() :: %Adbc.Result{
  data: [
    %Adbc.Column{
      data: term(),
      length: term(),
      metadata: term(),
      name: term(),
      nullable: term(),
      offset: term(),
      type: term()
    }
  ],
  num_rows: non_neg_integer() | nil
}

Functions

materialize(result)

@spec materialize(
  %Adbc.Result{data: term(), num_rows: term()}
  | {:ok, %Adbc.Result{data: term(), num_rows: term()}}
  | {:error, String.t()}
) ::
  %Adbc.Result{data: term(), num_rows: term()}
  | {:ok, %Adbc.Result{data: term(), num_rows: term()}}
  | {:error, String.t()}

materialize/1 converts the result set's data from reference type to regular Elixir terms.

to_map(result)

Returns a map of columns as a result.