GitHub

ClickhouseClientConfig

API reference for ClickhouseClientConfig.

A ClickHouse server to talk to over its HTTP interface.

  • url: the server (default http://localhost:8123; see the module)
  • pathname: a path the server is behind (/clickhouse)
  • username / password (default user default), or access_token (a JWT, sent as a bearer token)
  • database: the default database (default)
  • clickhouse_settings: settings sent with every request
  • http_headers: headers sent with every request
  • application: named in the User-Agent
  • session_id / role: the session and roles of every request
  • request_timeout: how long a request may stay idle (30 s), as the timeout of the client make creates
  • max_open_connections: connections open at once (10)
  • compression, keep_alive, tls, log, json: @clickhouse/client's options of those names (options)
  • use_multipart_params: a query's parameters, and the query, go in a multipart/form-data body instead of the URL; use_multipart_params_auto does so once the parameters would take more than 4096 characters of the URL
  • http_client: the HttpClient to send requests with; by default make creates one on httpx (pyfect-dev[httpx]), closed with the client (keep_alive, max_open_connections and tls configure that one only)
  • span_attributes: added to every statement's span
  • transform_result_names / transform_query_names: rename result columns / identifiers (fx.case has the usual ones)

Attributes

AttributeTypeDescription
urlstr = DEFAULT_URL
pathnamestr | None = None
usernamestr | None = None
passwordRedacted[str] | None = None
access_tokenRedacted[str] | None = None
databasestr | None = None
clickhouse_settingsSettings = field(default_factory=(dict[str, Setting]))
http_headersMapping[str, str] = field(default_factory=(dict[str, str]))
applicationstr | None = None
session_idstr | None = None
rolestr | Sequence[str] | None = None
request_timeoutDurationInput | None = None
max_open_connectionsint | None = None
compressionCompression | None = None
keep_aliveKeepAlive | None = None
tlsTls | None = field(default=None, repr=False)
logLog | None = None
jsonJsonHandling | None = field(default=None, compare=False)
use_multipart_paramsbool = False
use_multipart_params_autobool = False
http_clientHttpClientService[HttpClientError] | None = field(default=None, compare=False)
span_attributesMapping[str, object] = field(default_factory=(dict[str, object]))
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None
connectionConnection = field(init=False, repr=False, compare=False)

Functions

__init__

__init__(*, url=DEFAULT_URL, pathname=None, username=None, password=None, access_token=None, database=None, clickhouse_settings=dict[str, Setting](), http_headers=dict[str, str](), application=None, session_id=None, role=None, request_timeout=None, max_open_connections=None, compression=None, keep_alive=None, tls=None, log=None, json=None, use_multipart_params=False, use_multipart_params_auto=False, http_client=None, span_attributes=dict[str, object](), transform_result_names=None, transform_query_names=None) -> None
ParameterTypeDescription
urlstr = DEFAULT_URL
pathnamestr | None = None
usernamestr | None = None
passwordRedacted[str] | None = None
access_tokenRedacted[str] | None = None
databasestr | None = None
clickhouse_settingsSettings = dict[str, Setting]()
http_headersMapping[str, str] = dict[str, str]()
applicationstr | None = None
session_idstr | None = None
rolestr | Sequence[str] | None = None
request_timeoutDurationInput | None = None
max_open_connectionsint | None = None
compressionCompression | None = None
keep_aliveKeepAlive | None = None
tlsTls | None = None
logLog | None = None
jsonJsonHandling | None = None
use_multipart_paramsbool = False
use_multipart_params_autobool = False
http_clientHttpClientService[HttpClientError] | None = None
span_attributesMapping[str, object] = dict[str, object]()
transform_result_namesCallable[[str], str] | None = None
transform_query_namesCallable[[str], str] | None = None