Skip to content

Settings

Configuration for the ClickHouse client connection. Settings can be provided via environment variables (with CLICKHOUSE_ prefix), keyword arguments, or a Settings object.

Settings

Bases: BaseSettings

access_token = None class-attribute instance-attribute

apply_server_timezone = None class-attribute instance-attribute

autogenerate_query_id = None class-attribute instance-attribute

autogenerate_session_id = None class-attribute instance-attribute

ca_cert = None class-attribute instance-attribute

client_cert = None class-attribute instance-attribute

client_cert_key = None class-attribute instance-attribute

client_name = None class-attribute instance-attribute

compress = True class-attribute instance-attribute

connect_timeout = 10 class-attribute instance-attribute

connector_limit = 100 class-attribute instance-attribute

connector_limit_per_host = 20 class-attribute instance-attribute

database = '__default__' class-attribute instance-attribute

dsn = None class-attribute instance-attribute

form_encode_query_params = False class-attribute instance-attribute

host = 'localhost' class-attribute instance-attribute

http_proxy = None class-attribute instance-attribute

https_proxy = None class-attribute instance-attribute

interface = 'http' class-attribute instance-attribute

keepalive_timeout = 30.0 class-attribute instance-attribute

model_config = SettingsConfigDict(extra='allow', env_prefix='CLICKHOUSE_') class-attribute instance-attribute

password = '' class-attribute instance-attribute

port = 8123 class-attribute instance-attribute

proxy_path = '' class-attribute instance-attribute

query_limit = 0 class-attribute instance-attribute

query_retries = 2 class-attribute instance-attribute

secure = False class-attribute instance-attribute

send_receive_timeout = 300 class-attribute instance-attribute

server_host_name = None class-attribute instance-attribute

session_id = None class-attribute instance-attribute

settings = None class-attribute instance-attribute

show_clickhouse_errors = None class-attribute instance-attribute

tls_mode = None class-attribute instance-attribute

username = None class-attribute instance-attribute

utc_tz_aware = None class-attribute instance-attribute

verify = True class-attribute instance-attribute

client_kwargs()

Source code in src/pyclickhouse/settings.py 
45
46
47
48
49
50
51
52
53
54
55
56
57
def client_kwargs(self) -> dict[str, Any]:
    return self.model_dump(
        exclude={
            "host",
            "port",
            "username",
            "password",
            "database",
            "interface",
            "secure",
            "dsn",
        }
    )