Clickhouse (Clickhouse v0.1.0) View Source

A Clickhouse client.

This currently represents an early work in progress.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Executes a query using a Clickhouse client.

Starts a Clickhouse client.

Link to this section Types

Specs

name() :: atom()

Specs

option() ::
  {:name, name()}
  | {:interface, Clickhouse.Interface.t()}
  | {:interface_opts, keyword()}

Specs

options() :: [option()]

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

query(name(), statetment :: binary()) ::
  {:ok, Clickhouse.Result.t()} | {:error, Clichouse.Error.t()}

Executes a query using a Clickhouse client.

Specs

start_link(options()) :: Supervisor.on_start()

Starts a Clickhouse client.

Options

  • :name - The name of the client - defaults to :default.
  • :interface - The interface to use for queries - defaults to Clickhouse.Interface.HTTP.
  • :interface_opts - Additional keyword options to pass to the interface.