npm / @clickhouse/client-web
@clickhouse/client-web
What changed in @clickhouse/client-web 1, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-22.
5 breaking3 deprecations7 new APIs and options4 behavior and defaults4 fixes and other
See which of these apply to your code, ranked, in your agent:
npx @unstale/cli init@clickhouse/client-web 123 changes
Breaking changes 5
A standalone, dependency-free package parses ClickHouse data-type strings and emits a JSON AST, superseding parseColumnType.
@clickhouse/client-web rejects the zstd codec at client creation, so zstd compression cannot be configured for the web client.
Spans now follow OpenTelemetry database semantic conventions, replacing several ClickHouse-specific attribute names and recording standardized database and request attributes.
Successful spans leave status unset; failed spans record error.type and server-side errors also record clickhouse.error.code.
The client now detects server errors from this response header even with a successful HTTP status and rejects the request with a parsed ClickHouseError.
Deprecations 3
The package is deprecated and will no longer receive updates; import its previously available exports from @clickhouse/client or @clickhouse/client-web instead.
This function is deprecated and slated for removal in a future major version; use parseDataType from @clickhouse/datatype-parser instead.
This companion is deprecated and slated for removal in a future major version; use the standalone @clickhouse/datatype-parser package instead.
New APIs and options 7
Exports QueryParamsWithFormat, ClickHouseSummary, WithClickHouseSummary, ResultJSONType, RowJSONType, and PingParams from the package root.
Adds a client option, defaulting to false, that attaches raw SQL to spans as db.query.text; bound query_params values and credentials are never traced.
Per-request query params accept span_attributes to enrich the operation span with application-level context; caller attributes do not override client attributes.
A package-neutral structural settings type is exported from @clickhouse/client-web, allowing a shared settings-producing helper to type its output for both Node.js and Web clients without casts.
The insert span records clickhouse.request.sent_rows for array-based inserts.
Adds a client option, defaulting to false, that sends query_params as multipart/form-data for queries; it can also be overridden per query.
Adds a client option, defaulting to false, that automatically sends query_params as multipart/form-data when their URL-encoded length exceeds 4096 characters; it can also be overridden per query.
Behavior and default changes 4
The attribute is recorded for non-streaming result consumption, including json() on JSON formats.
The Web client parses the summary header and attaches its keys as clickhouse.summary.<key> attributes to operation spans.
Queries emit an HTTP-lifetime clickhouse.query span and a child clickhouse.query.stream span that tracks response consumption and records final stream metrics.
Spans now record HTTP response status and available ClickHouse summary counters.
Fixes and other changes 4
Date values nested in arrays, tuples, and maps are emitted as quoted UTC date strings; nested Array(DateTime) and Array(DateTime64) dates are bound at day precision.
Re-exported from @clickhouse/client-web after being missed when the @clickhouse/client-common public API was bundled into the client packages.
Re-exported from @clickhouse/client-web after being missed when the @clickhouse/client-common public API was bundled into the client packages.
The Web stream path now ends its query stream span when the source aborts or the consumer cancels, fixing a span leak.