clickhousex v0.2.3 Clickhousex View Source

Clickhouse driver for Elixir.

This module handles the connection to Clickhouse, providing support for queries, connection backoff, logging, pooling and more.

Link to this section Summary

Types

A connection process name, pid or reference

Functions

Connect to ClickHouse. opts expects a keyword list with zero or more of:

* `:scheme` - Scheme (:http | :https).
    * default value: :http
* `:hostname` - The server hostname.
    * default value: localhost
* `:database` - Database name.
    * default value: "default"
* `:port` - The server port number.
    * default value: 8123
* `:username` - Username.
    * default value: empty
* `:password` - User's password.
    * default value: empty

Link to this section Types

A connection process name, pid or reference.

A connection reference is used when making multiple requests to the same connection, see transaction/3.

Link to this section Functions

Link to this function query!(conn, statement, params, opts \\ []) View Source
query!(pid(), binary(), list(), Keyword.t()) ::
  {iodata(), Clickhousex.Result.t()}
Link to this function query(conn, statement, params, opts \\ []) View Source
query(pid(), binary(), list(), Keyword.t()) ::
  {:ok, iodata(), Clickhousex.Result.t()}
Link to this function start_link(opts) View Source
start_link(Keyword.t()) :: {:ok, pid()} | {:error, term()}

Connect to ClickHouse. opts expects a keyword list with zero or more of:

* `:scheme` - Scheme (:http | :https).
    * default value: :http
* `:hostname` - The server hostname.
    * default value: localhost
* `:database` - Database name.
    * default value: "default"
* `:port` - The server port number.
    * default value: 8123
* `:username` - Username.
    * default value: empty
* `:password` - User's password.
    * default value: empty