ClickHouse v0.9.0

ClickHouse.Query (ClickHouse v0.9.0) View Source

A ClickHouse query.

Link to this section Summary

Types

command()
t()

Functions

encode(query)
get_statement(query)
new(client, statement, params \\ [], opts \\ [])
put_encoded(query, encoded)

Link to this section Types

Link to this type

command()

View Source

Specs

command() :: :create | :select | :insert | :alter | :unknown
Link to this type

t()

View Source

Specs

t() :: %ClickHouse.Query{
  client: ClickHouse.client(),
  command: command(),
  encoded: binary() | nil,
  format: ClickHouse.format() | nil,
  interface: ClickHouse.interface() | nil,
  opts: term(),
  params: ClickHouse.params(),
  params_count: non_neg_integer(),
  statement: ClickHouse.statement()
}

Link to this section Functions

Link to this function

encode(query)

View Source

Specs

encode(t()) :: {:ok, t()} | {:error, ClickHouse.FormatError.t()}
Link to this function

get_statement(query)

View Source

Specs

get_statement(t()) :: binary()
Link to this function

new(client, statement, params \\ [], opts \\ [])

View Source

Specs

new(ClickHouse.client(), ClickHouse.statement(), ClickHouse.params(), keyword()) ::
  t()
Link to this function

put_encoded(query, encoded)

View Source

Specs

put_encoded(t(), binary()) :: t()