ClickHouse.Result (ClickHouse v0.21.0) View Source

The results of a ClickHouse query.

Link to this section Summary

Types

The name of the column.

The data type of the column.

The names and data types of columns.

The rows returned from ClickHouse.

t()

The result of a ClickHouse query.

Link to this section Types

Specs

column_name() :: binary()

The name of the column.

Specs

column_type() ::
  :i64
  | :i32
  | :i16
  | :i8
  | :u64
  | :u32
  | :u16
  | :u8
  | :f64
  | :f32
  | :string
  | :uuid
  | :date
  | :datetime
  | {:fixed_string, integer()}
  | {:enum8, [binary()]}
  | {:enum16, [binary()]}
  | {:array, column_type()}
  | {:low_cardinality, column_type()}
  | {:nullable, column_type()}

The data type of the column.

Specs

columns() :: [{column_name(), column_type()}, ...] | nil

The names and data types of columns.

Specs

rows() :: [] | [list(), ...] | nil

The rows returned from ClickHouse.

Specs

t() :: %ClickHouse.Result{
  columns: columns(),
  compressed: boolean(),
  format: ClickHouse.Format.t(),
  meta: map(),
  raw: binary(),
  rows: rows()
}

The result of a ClickHouse query.

Link to this section Functions

Specs

decode(t()) :: t()
Link to this function

new(client, raw, format, meta, compressed)

View Source

Specs

new(ClickHouse.Client.t(), binary(), binary(), map(), boolean()) :: t()