Optional
access_empty
Optional
additional_since version 1.0.0. Use http_headers instead.
Additional HTTP headers to attach to the outgoing requests.
empty object
Optional
applicationThe name of the application using the JS client.
empty string
Optional
clickhouse_ClickHouse settings to apply to all requests.
empty object
Optional
compressionRequest and response compression settings.
Optional
request?: booleanrequest: true
enabled compression on the client request body.
false
Optional
response?: booleanresponse: true
instructs ClickHouse server to respond with compressed response body.
This will add Accept-Encoding: gzip
header in the request and enable_http_compression=1
ClickHouse HTTP setting.
Warning: Response compression can't be enabled for a user with readonly=1, as ClickHouse will not allow settings modifications for such user.
false
Optional
databaseDatabase name to use.
default
Optional
hostsince version 1.0.0. Use url instead.
A ClickHouse instance URL.
http://localhost:8123
Optional
http_Additional HTTP headers to attach to the outgoing requests.
empty object
Optional
keep_HTTP Keep-Alive related settings.
Optional
enabled?: booleanEnable or disable HTTP Keep-Alive mechanism.
true
Optional
logOptional
LoggerOptional
level?: ClickHouseLogLevelset to {@link ClickHouseLogLevel.OFF}
Optional
max_Maximum number of sockets to allow per host.
10
Optional
passwordThe user password. Should not be set if access_token is provided.
empty string
Optional
pathnameAn optional pathname to add to the ClickHouse URL after it is parsed by the client.
For example, if you use a proxy, and your ClickHouse instance can be accessed as http://proxy:8123/clickhouse_server,
specify clickhouse_server
here (with or without a leading slash);
otherwise, if provided directly in the url, it will be considered as the database
option.
Multiple segments are supported, e.g. /my_proxy/db
.
empty string
Optional
request_The request timeout in milliseconds.
30_000
Optional
roleClickHouse role name(s) to attach to the outgoing requests.
undefined string (no roles)
Optional
session_ClickHouse Session id to attach to the outgoing requests.
empty string (no session)
Optional
urlA ClickHouse instance URL.
http://localhost:8123
Optional
usernameThe name of the user on whose behalf requests are made. Should not be set if access_token is provided.
default
Generated using TypeDoc
A JWT access token to authenticate with ClickHouse. JWT token authentication is supported in ClickHouse Cloud only. Should not be set if username or password are provided.