@clickhouse/client-common
Advanced tools
Changelog
0.3.1 (Common, Node.js, Web)
Changelog
0.3.0 (Node.js only)
This release primarily focuses on improving the Keep-Alive mechanism's reliability on the client side.
Idle sockets timeout rework; now, the client attaches internal timers to idling sockets, and forcefully removes them from the pool if it considers that a particular socket is idling for too long. The intention of this additional sockets housekeeping is to eliminate "Socket hang-up" errors that could previously still occur on certain configurations. Now, the client does not rely on KeepAlive agent when it comes to removing the idling sockets; in most cases, the server will not close the socket before the client does.
There is a new keep_alive.idle_socket_ttl
configuration parameter. The default value is 2500
(milliseconds), which is considered to be safe, as ClickHouse versions prior to 23.11 had keep_alive_timeout
set to 3 seconds by default, and keep_alive.idle_socket_ttl
is supposed to be slightly less than that to allow the client to remove the sockets that are about to expire before the server does so.
Logging improvements: more internal logs on failing requests; all client methods except ping will log an error on failure now. A failed ping will log a warning, since the underlying error is returned as a part of its result. Client logging still needs to be enabled explicitly by specifying the desired log.level
config option, as the log level is OFF
by default. Currently, the client logs the following events, depending on the selected log.level
value:
TRACE
- low-level information about the Keep-Alive sockets lifecycle.DEBUG
- response information (without authorization headers and host info).INFO
- still mostly unused, will print the current log level when the client is initialized.WARN
- non-fatal errors; failed ping
request is logged as a warning, as the underlying error is included in the returned result.ERROR
- fatal errors from query
/insert
/exec
/command
methods, such as a failed request.keep_alive.retry_on_expired_socket
and keep_alive.socket_ttl
configuration parameters are removed.max_open_connections
configuration parameter is now 10 by default, as we should not rely on the KeepAlive agent's defaults.request_timeout
configuration value (now it is correctly set to 30_000
, previously 300_000
(milliseconds)).Connection
header value considering Keep-Alive settings. If Keep-Alive is disabled, its value is now forced to "close".Changelog
0.2.10 (Common, Node.js, Web)
InsertParams.values
is an empty array, no request is sent to the server and ClickHouseClient.insert
short-circuits itself. In this scenario, the newly added InsertResult.executed
flag will be false
, and InsertResult.query_id
will be an empty string.Code: 354. inflate failed: buffer error
exception if request compression is enabled and InsertParams.values
is an empty array (see above).Changelog
0.2.9 (Common, Node.js, Web)
const client = createClient({
additional_headers: {
'X-ClickHouse-User': 'clickhouse_user',
'X-ClickHouse-Key': 'clickhouse_password',
},
})
Changelog
0.2.8 (Common, Node.js, Web)
import { createClient } from '@clickhouse/client-web'
const client = createClient({ keep_alive: { enabled: true } })
// Generated query: INSERT INTO mytable (message) FORMAT JSONEachRow
await client.insert({
table: 'mytable',
format: 'JSONEachRow',
values: [{ message: 'foo' }],
columns: ['message'],
})
// Generated query: INSERT INTO mytable (* EXCEPT (message)) FORMAT JSONEachRow
await client.insert({
table: 'mytable',
format: 'JSONEachRow',
values: [{ id: 42 }],
columns: { except: ['message'] },
})
See also the new examples:
Changelog
0.2.7 (Common, Node.js, Web)
X-ClickHouse-Summary
response header is now parsed when working with insert
/exec
/command
methods.
See the related test for more details.
NB: it is guaranteed to be correct only for non-streaming scenarios.
Web version does not currently support this due to CORS limitations. (#210)async_insert
, especially in the Cloudflare Workers context.Changelog
0.2.6 (Common, Node.js)