GitHub

Connection

API reference for Connection.

Where and as whom requests go, as the config and its URL say.

Attributes

AttributeTypeDescription
urlstr

The server's base URL, pathname included, without a trailing /.

databasestr
authorizationRedacted[str]
clickhouse_settingsSettings
http_headersMapping[str, str]
applicationstr | None
session_idstr | None
roletuple[str, ...]
request_timeoutDuration
max_open_connectionsfloat = 10

At most this many connections at once (math.inf: no limit).

compress_requestRequestCodec | None = None
decompress_responseCompressionCodec | None = None
keep_alivebool = True
idle_socket_ttlDuration = DEFAULT_IDLE_SOCKET_TTL
tlsTlsContext | None = None

The tls option on an https URL.

tls_credentialstuple[str, Redacted[str]] | None = None

The user and password sent in X-ClickHouse-User / -Key instead of Authorization: with tls on an https URL, and no http_client of the config's.

log_levelint = LOG_LEVELS['WARN']
jsonJson = field(default_factory=Json)
use_multipart_paramsbool = False
use_multipart_params_autobool = False
warningstuple[str, ...] = ()

What the config logs as Config warnings when the client is made.

Functions

__init__

__init__(*, url, database, authorization, clickhouse_settings, http_headers, application, session_id, role, request_timeout, max_open_connections=10, compress_request=None, decompress_response=None, keep_alive=True, idle_socket_ttl=DEFAULT_IDLE_SOCKET_TTL, tls=None, tls_credentials=None, log_level=LOG_LEVELS['WARN'], json=Json(), use_multipart_params=False, use_multipart_params_auto=False, warnings=()) -> None
ParameterTypeDescription
urlstr
databasestr
authorizationRedacted[str]
clickhouse_settingsSettings
http_headersMapping[str, str]
applicationstr | None
session_idstr | None
roletuple[str, ...]
request_timeoutDuration
max_open_connectionsfloat = 10
compress_requestRequestCodec | None = None
decompress_responseCompressionCodec | None = None
keep_alivebool = True
idle_socket_ttlDuration = DEFAULT_IDLE_SOCKET_TTL
tlsTlsContext | None = None
tls_credentialstuple[str, Redacted[str]] | None = None
log_levelint = LOG_LEVELS['WARN']
jsonJson = Json()
use_multipart_paramsbool = False
use_multipart_params_autobool = False
warningstuple[str, ...] = ()

logs

logs(level) -> bool
ParameterTypeDescription
levelLogLevel

Returns bool

def logs(self, level: LogLevel) -> bool:
    return self.log_level <= LOG_LEVELS[level]