@spec binary([iodata() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains binary values.

Arguments

• data: A list of binary values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.binary([<<0>>, <<1>>, <<2>>])
%Adbc.Column{
  name: nil,
  type: :binary,
  nullable: false,
  metadata: nil,
  data: [<<0>>, <<1>>, <<2>>]
}

@spec boolean([boolean()], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains booleans.

Arguments

• data: A list of booleans
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.boolean([true, false, true])
%Adbc.Column{
  name: nil,
  type: :boolean,
  nullable: false,
  metadata: nil,
  data: [true, false, true]
}

@spec date32([Date.t() | s32() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains date represented as 32-bit signed integers in UTC.

Arguments

• data: a list, each element of which can be one of the following:
  • a Date.t()
  • a 32-bit signed integer representing the number of days since the Unix epoch.
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec date64([Date.t() | s64() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains date represented as 64-bit signed integers in UTC.

Arguments

• data: a list, each element of which can be one of the following:
  • a Date.t()
  • a 64-bit signed integer representing the number of milliseconds since the Unix epoch.
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec decimal128(
  [Decimal.t() | integer() | nil],
  precision128(),
  integer(),
  Keyword.t()
) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains 128-bit decimals.

Arguments

• data: a list, each element can be either
  • a Decimal.t()
  • an integer()
• precision: The precision of the decimal values; precision should be between 1 and 38
• scale: The scale of the decimal values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec decimal256(
  [Decimal.t() | integer() | nil],
  precision256(),
  integer(),
  Keyword.t()
) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains 256-bit decimals.

Arguments

• data: a list, each element can be either
  • a Decimal.t()
  • an integer()
• precision: The precision of the decimal values; precision should be between 1 and 76
• scale: The scale of the decimal values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec dictionary(
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  },
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  },
  Keyword.t()
) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

Construct an array using dictionary encoding.

Dictionary encoding is a data representation technique to represent values by integers referencing a dictionary usually consisting of unique values. It can be effective when you have data with many repeated values.

Any array can be dictionary-encoded. The dictionary is stored as an optional property of an array. When a field is dictionary encoded, the values are represented by an array of non-negative integers representing the index of the value in the dictionary. The memory layout for a dictionary-encoded array is the same as that of a primitive integer layout. The dictionary is handled as a separate columnar array with its own respective layout.

As an example, you could have the following data:

Adbc.Column.string(["foo", "bar", "foo", "bar", nil, "baz"], nullable: true)

In dictionary-encoded form, this could appear as:

Adbc.Column.dictionary(
  Adbc.Column.string(["foo", "bar", "baz"], nullable: true),
  Adbc.Column.s32([0, 1, 0, 1, nil, 2], nullable: true)
)

Arguments

• data: a list, each element of which can be one of the following:

  • nil
  • Adbc.Column

  Note that each Adbc.Column in the list should have the same type.

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec duration([s64() | nil], time_unit(), Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains durations represented as 64-bit signed integers.

Arguments

• data: a list of integer values representing the time in the specified unit

• unit: specify the unit of the time value, one of the following:

  • :seconds
  • :milliseconds
  • :microseconds
  • :nanoseconds

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec f16([float() | nil | :infinity | :neg_infinity | :nan], Keyword.t()) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains 16-bit half-precision floats.

Arguments

• data: A list of 32-bit single-precision float values (will be converted to 16-bit floats in C)
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.f16([1.0, 2.0, 3.0])
%Adbc.Column{
  name: nil,
  type: :f16,
  nullable: false,
  metadata: nil,
  data: [1.0, 2.0, 3.0]
}

@spec f32([float() | nil | :infinity | :neg_infinity | :nan], Keyword.t()) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains 32-bit single-precision floats.

Arguments

• data: A list of 32-bit single-precision float values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.f32([1.0, 2.0, 3.0])
%Adbc.Column{
  name: nil,
  type: :f32,
  nullable: false,
  metadata: nil,
  data: [1.0, 2.0, 3.0]
}

@spec f64([float() | nil | :infinity | :neg_infinity | :nan], Keyword.t()) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains 64-bit double-precision floats.

Arguments

• data: A list of 64-bit double-precision float values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.f64([1.0, 2.0, 3.0])
%Adbc.Column{
  name: nil,
  type: :f64,
  nullable: false,
  metadata: nil,
  data: [1.0, 2.0, 3.0]
}

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

A column that contains fixed size binaries.

Similar to binary/2, but each binary value has the same fixed size in bytes.

Arguments

• data: A list of binary values
• nbytes: The fixed size of the binary values in bytes
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.fixed_size_binary([<<0>>, <<1>>, <<2>>], 1)
%Adbc.Column{
  name: nil,
  type: {:fixed_size_binary, 1},
  nullable: false,
  metadata: nil,
  data: [<<0>>, <<1>>, <<2>>]
}

@spec fixed_size_list(
  [
    %Adbc.Column{
      data: term(),
      length: term(),
      metadata: term(),
      name: term(),
      nullable: term(),
      offset: term(),
      type: term()
    }
    | nil
  ],
  s32(),
  Keyword.t()
) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

Similar to list/2, but the length of the list is the same.

Arguments

• data: a list, each element of which can be one of the following:

  • nil
  • Adbc.Column

  Note that each Adbc.Column in the list should have the same type and length.

• fixed_size: The fixed size of the list.

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec interval(
  [interval_month() | interval_day_time() | interval_month_day_nano() | nil],
  interval_unit(),
  Keyword.t()
) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains durations represented as signed integers.

Arguments

• data: a list, each element of which can be one of the following:

  • if unit is :month:

    • a 32-bit signed integer representing the number of months.

  • if unit is :day_time:

    • a 2-tuple, both the number of days and the number of milliseconds are in 32-bit signed integers.

  • if unit is :month_day_nano:

    • a 3-tuple, the number of months, days, and nanoseconds; the number of months and days are in 32-bit signed integers, and the number of nanoseconds is in 64-bit signed integers

• unit: specify the unit of the time value, one of the following:

  • :month
  • :day_time
  • :month_day_nano

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec large_binary([iodata() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains large binary values.

Similar to binary/2, but for binary values larger than 2GB.

Arguments

• data: A list of binary values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.large_binary([<<0>>, <<1>>, <<2>>])
%Adbc.Column{
  name: nil,
  type: :large_binary,
  nullable: false,
  metadata: nil,
  data: [<<0>>, <<1>>, <<2>>]
}

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

Similar to list/2, but for large lists.

Arguments

• data: a list, each element of which can be one of the following:

  • nil
  • Adbc.Column

  Note that each Adbc.Column in the list should have the same type.

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec large_string([String.t() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains UTF-8 encoded large strings.

Similar to string/2, but for strings larger than 2GB.

Arguments

• data: A list of UTF-8 encoded string values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.large_string(["a", "ab", "abc"])
%Adbc.Column{
  name: nil,
  type: :large_string,
  nullable: false,
  metadata: nil,
  data: ["a", "ab", "abc"]
}

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

A column that each row is a list of some type or nil.

Arguments

• data: a list, each element of which can be one of the following:

  • nil
  • Adbc.Column

  Note that each Adbc.Column in the list should have the same type.

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec materialize(%Adbc.Column{
  data: reference() | [reference()] | list() | map(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }
  | {:error, String.t()}

materialize/1 converts a column's data from reference type to regular Elixir terms.

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

A column that contains signed 8-bit integers.

Arguments

• data: A list of signed 8-bit integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.s8([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :s8,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains signed 16-bit integers.

Arguments

• data: A list of signed 16-bit integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.s16([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :s16,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains 32-bit signed integers.

Arguments

• data: A list of 32-bit signed integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.s32([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :s32,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains 64-bit signed integers.

Arguments

• data: A list of 64-bit signed integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.s64([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :s64,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

@spec string([String.t() | nil], Keyword.t()) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

A column that contains UTF-8 encoded strings.

Arguments

• data: A list of UTF-8 encoded string values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.string(["a", "ab", "abc"])
%Adbc.Column{
  name: nil,
  type: :string,
  nullable: false,
  metadata: nil,
  data: ["a", "ab", "abc"]
}

@spec time([Time.t() | nil] | [s64() | nil], time_unit(), Keyword.t()) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains time represented as signed integers in UTC.

Arguments

• data:

  • a list of Time.t() value

  • a list of integer values representing the time in the specified unit

    Note that when using :seconds or :milliseconds as the unit, the time value is limited to the range of 32-bit signed integers.

    For :microseconds and :nanoseconds, the time value is limited to the range of 64-bit signed integers.

• unit: specify the unit of the time value, one of the following:

  • :seconds
  • :milliseconds
  • :microseconds
  • :nanoseconds

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec timestamp(
  [NaiveDateTime.t() | nil] | [s64() | nil],
  time_unit(),
  String.t(),
  Keyword.t()
) ::
  %Adbc.Column{
    data: term(),
    length: term(),
    metadata: term(),
    name: term(),
    nullable: term(),
    offset: term(),
    type: term()
  }

A column that contains timestamps represented as signed integers in the given timezone.

Arguments

• data:

  • a list of NaiveDateTime.t() value
  • a list of 64-bit signed integer values representing the time in the specified unit

• unit: specify the unit of the time value, one of the following:

  • :seconds
  • :milliseconds
  • :microseconds
  • :nanoseconds

• timezone: the timezone of the timestamp

• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

@spec to_list(%Adbc.Column{
  data: map(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}) :: %Adbc.Column{
  data: term(),
  length: term(),
  metadata: term(),
  name: term(),
  nullable: term(),
  offset: term(),
  type: term()
}

Convert a list view, run-end encoding array or a dictionary to a list.

Examples

iex> list_view = %Adbc.Column{
...>   name: nil,
...>   type: :list_view,
...>   nullable: true,
...>   metadata: nil,
...>   data: %{
...>     values: %Adbc.Column{
...>       name: "item",
...>       type: :s32,
...>       nullable: false,
...>       metadata: nil,
...>       data: [0, -127, 127, 50, 12, -7, 25]
...>     },
...>     validity: [true, false, true, true, true],
...>     offsets: [4, 7, 0, 0, 3],
...>     sizes: [3, 0, 4, 0, 2]
...>   }
...> }
%Adbc.Column{
  name: nil,
  type: :list_view,
  nullable: true,
  metadata: nil,
  data: %{
    offsets: [4, 7, 0, 0, 3],
    sizes: [3, 0, 4, 0, 2],
    validity: [true, false, true, true, true],
    values: %Adbc.Column{
      name: "item",
      type: :s32,
      nullable: false,
      metadata: nil,
      data: [0, -127, 127, 50, 12, -7, 25]
    }
  }
}
iex> Adbc.Column.to_list(list_view)
%Adbc.Column{
  name: nil,
  type: :list,
  nullable: true,
  metadata: nil,
  data: [
    %Adbc.Column{
      name: "item",
      type: :s32,
      nullable: false,
      metadata: nil,
      data: [12, -7, 25]
    },
    nil,
    %Adbc.Column{
      name: "item",
      type: :s32,
      nullable: false,
      metadata: nil,
      data: [0, -127, 127, 50]
    },
    %Adbc.Column{
      name: "item",
      type: :s32,
      nullable: false,
      metadata: nil,
      data: []
    },
    %Adbc.Column{
      name: "item",
      type: :s32,
      nullable: false,
      metadata: nil,
      data: ~c"2"
    }
  ]
}

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

A column that contains unsigned 8-bit integers.

Arguments

• data: A list of unsigned 8-bit integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.u8([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :u8,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains unsigned 16-bit integers.

Arguments

• data: A list of unsigned 16-bit integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.u16([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :u16,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains un32-bit signed integers.

Arguments

• data: A list of un32-bit signed integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.u32([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :u32,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}

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

A column that contains un64-bit signed integers.

Arguments

• data: A list of un64-bit signed integer values
• opts: A keyword list of options

Options

• :name - The name of the column
• :nullable - A boolean value indicating whether the column is nullable
• :metadata - A map of metadata

Examples

iex> Adbc.Column.u32([1, 2, 3])
%Adbc.Column{
  name: nil,
  type: :u32,
  nullable: false,
  metadata: nil,
  data: [1, 2, 3]
}