GitHub

API reference for config.

Settings of a ClickHouse client (Effect's ClickhouseClientConfig, the options of @clickhouse/client's createClient).

The URL is parsed when the config is made, with @clickhouse/client's rules: http[s]://[username:password@]host:port[/database], its query naming settings (clickhouse_setting_<name> or ch_<name>), headers (http_header_<name>), application, pathname, session_id, request_timeout (milliseconds), access_token, max_open_connections, compression_request / compression_response (booleans), keep_alive_enabled, keep_alive_idle_socket_ttl and log_level; any other parameter fails as unknown. What the URL says overrides the fields of the same name (with a warning logged when the client is made). connection is the result.

Values

AttributeTypeDescription
DEFAULT_URLLiteral['http://localhost:8123'] = 'http://localhost:8123'
DEFAULT_REQUEST_TIMEOUTDuration
DEFAULT_IDLE_SOCKET_TTLDuration

Classes