GitHub

clickhouse

API reference for clickhouse.

ClickHouse (Effect's @effect/sql-clickhouse): an SqlClient over ClickHouse's HTTP interface, sent with a pyfect HttpClient (by default one on httpx, the pyfect-dev[httpx] extra)::

from pyfect.sql import clickhouse

layer = clickhouse.layer(clickhouse.ClickhouseClientConfig(url="http://localhost:8123"))
  • client: ClickhouseClient (an SqlClient with param, as_command, insert_query, with_query_id, with_clickhouse_settings, its config and client), make, layer, layer_config, layer_from, make_compiler, and the ClientMethod / QueryId / ClickhouseSettings references
  • config: ClickhouseClientConfig
  • options: the @clickhouse/client options it takes (compression, keep_alive, tls, log, json)
  • driver: ClickhouseDriver, the HTTP client underneath (query, command, exec, insert, ping) and its results
  • params: how values are sent (TupleParam, settings, inferred types)
  • error: ClickhouseError and the SqlError reasons of its codes
  • migrator: migrations

Re-exports

Classes

Modules