A ClickHouse server to talk to over its HTTP interface.
url: the server (defaulthttp://localhost:8123; see the module)pathname: a path the server is behind (/clickhouse)username/password(default userdefault), oraccess_token(a JWT, sent as a bearer token)database: the default database (default)clickhouse_settings: settings sent with every requesthttp_headers: headers sent with every requestapplication: named in theUser-Agentsession_id/role: the session and roles of every requestrequest_timeout: how long a request may stay idle (30 s), as the timeout of the clientmakecreatesmax_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 amultipart/form-databody instead of the URL;use_multipart_params_autodoes so once the parameters would take more than 4096 characters of the URLhttp_client: theHttpClientto send requests with; by defaultmakecreates one on httpx (pyfect-dev[httpx]), closed with the client (keep_alive,max_open_connectionsandtlsconfigure that one only)span_attributes: added to every statement's spantransform_result_names/transform_query_names: rename result columns / identifiers (fx.casehas the usual ones)
Attributes#
| Attribute | Type | Description |
|---|---|---|
url | str = DEFAULT_URL | |
pathname | str | None = None | |
username | str | None = None | |
password | Redacted[str] | None = None | |
access_token | Redacted[str] | None = None | |
database | str | None = None | |
clickhouse_settings | Settings = field(default_factory=(dict[str, Setting])) | |
http_headers | Mapping[str, str] = field(default_factory=(dict[str, str])) | |
application | str | None = None | |
session_id | str | None = None | |
role | str | Sequence[str] | None = None | |
request_timeout | DurationInput | None = None | |
max_open_connections | int | None = None | |
compression | Compression | None = None | |
keep_alive | KeepAlive | None = None | |
tls | Tls | None = field(default=None, repr=False) | |
log | Log | None = None | |
json | JsonHandling | None = field(default=None, compare=False) | |
use_multipart_params | bool = False | |
use_multipart_params_auto | bool = False | |
http_client | HttpClientService[HttpClientError] | None = field(default=None, compare=False) | |
span_attributes | Mapping[str, object] = field(default_factory=(dict[str, object])) | |
transform_result_names | Callable[[str], str] | None = None | |
transform_query_names | Callable[[str], str] | None = None | |
connection | Connection = 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| Parameter | Type | Description |
|---|---|---|
url | str = DEFAULT_URL | |
pathname | str | None = None | |
username | str | None = None | |
password | Redacted[str] | None = None | |
access_token | Redacted[str] | None = None | |
database | str | None = None | |
clickhouse_settings | Settings = dict[str, Setting]() | |
http_headers | Mapping[str, str] = dict[str, str]() | |
application | str | None = None | |
session_id | str | None = None | |
role | str | Sequence[str] | None = None | |
request_timeout | DurationInput | None = None | |
max_open_connections | int | None = None | |
compression | Compression | None = None | |
keep_alive | KeepAlive | None = None | |
tls | Tls | None = None | |
log | Log | None = None | |
json | JsonHandling | None = None | |
use_multipart_params | bool = False | |
use_multipart_params_auto | bool = False | |
http_client | HttpClientService[HttpClientError] | None = None | |
span_attributes | Mapping[str, object] = dict[str, object]() | |
transform_result_names | Callable[[str], str] | None = None | |
transform_query_names | Callable[[str], str] | None = None |