clickhousex v0.5.0 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.

Link to this section Types

Specs

conn() :: DBConnection.conn()

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

Specs

child_spec(Keyword.t()) :: Supervisor.Spec.spec()
Link to this function

query(conn, statement, params \\ [], opts \\ [])

View Source

Specs

Link to this function

query!(conn, statement, params \\ [], opts \\ [])

View Source

Specs

Specs

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