@clickhouse/client 1.20.0 → 1.21.0

package/README.md

@@ -84,23 +84,23 @@ The client may work with older versions too; however, this is best-effort suppor
 ## Quick start
 
 ```ts
-import { createClient } from '@clickhouse/client' // or '@clickhouse/client-web'
+import { createClient } from "@clickhouse/client"; // or '@clickhouse/client-web'
 
 const client = createClient({
-  url: process.env.CLICKHOUSE_URL ?? 'http://localhost:8123',
-  username: process.env.CLICKHOUSE_USER ?? 'default',
-  password: process.env.CLICKHOUSE_PASSWORD ?? '',
-})
+  url: process.env.CLICKHOUSE_URL ?? "http://localhost:8123",
+  username: process.env.CLICKHOUSE_USER ?? "default",
+  password: process.env.CLICKHOUSE_PASSWORD ?? "",
+});
 
 const resultSet = await client.query({
-  query: 'SELECT * FROM system.tables',
-  format: 'JSONEachRow',
-})
+  query: "SELECT * FROM system.tables",
+  format: "JSONEachRow",
+});
 
-const tables = await resultSet.json()
-console.log(tables)
+const tables = await resultSet.json();
+console.log(tables);
 
-await client.close()
+await client.close();
 ```
 
 See more examples in the [examples directory](./examples).

package/dist/client.d.ts

@@ -1,14 +1,14 @@
-import type { DataFormat, IsSame, QueryParamsWithFormat } from '@clickhouse/client-common';
-import { ClickHouseClient } from '@clickhouse/client-common';
-import type Stream from 'stream';
-import type { NodeClickHouseClientConfigOptions } from './config';
-import type { ResultSet } from './result_set';
+import type { DataFormat, IsSame, QueryParamsWithFormat } from "@clickhouse/client-common";
+import { ClickHouseClient } from "@clickhouse/client-common";
+import type Stream from "stream";
+import type { NodeClickHouseClientConfigOptions } from "./config";
+import type { ResultSet } from "./result_set";
 /** If the Format is not a literal type, fall back to the default behavior of the ResultSet,
  *  allowing to call all methods with all data shapes variants,
  *  and avoiding generated types that include all possible DataFormat literal values. */
 export type QueryResult<Format extends DataFormat> = IsSame<Format, DataFormat> extends true ? ResultSet<unknown> : ResultSet<Format>;
 export declare class NodeClickHouseClient extends ClickHouseClient<Stream.Readable> {
     /** See {@link ClickHouseClient.query}. */
-    query<Format extends DataFormat = 'JSON'>(params: QueryParamsWithFormat<Format>): Promise<QueryResult<Format>>;
+    query<Format extends DataFormat = "JSON">(params: QueryParamsWithFormat<Format>): Promise<QueryResult<Format>>;
 }
 export declare function createClient(config?: NodeClickHouseClientConfigOptions): NodeClickHouseClient;

package/dist/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AA4BA,oCAOC;AA9BD,6DAA4D;AAG5D,qCAAyC;AAWzC,MAAa,oBAAqB,SAAQ,gCAAiC;IACzE,0CAA0C;IAC1C,KAAK,CACH,MAAqC;QAErC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAA+B,CAAA;IAC1D,CAAC;CACF;AAPD,oDAOC;AAED,SAAgB,YAAY,CAC1B,MAA0C;IAE1C,OAAO,IAAI,gCAAgB,CAAkB;QAC3C,IAAI,EAAE,uBAAc;QACpB,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAyB,CAAA;AAC5B,CAAC"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AA4BA,oCAOC;AA9BD,6DAA6D;AAG7D,qCAA0C;AAW1C,MAAa,oBAAqB,SAAQ,gCAAiC;IACzE,0CAA0C;IACjC,KAAK,CACZ,MAAqC;QAErC,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,CAA+B,CAAC;IAC3D,CAAC;CACF;AAPD,oDAOC;AAED,SAAgB,YAAY,CAC1B,MAA0C;IAE1C,OAAO,IAAI,gCAAgB,CAAkB;QAC3C,IAAI,EAAE,uBAAc;QACpB,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC;KAClB,CAAyB,CAAC;AAC7B,CAAC"}

package/dist/config.d.ts

@@ -1,8 +1,8 @@
-import type { ImplementationDetails } from '@clickhouse/client-common';
-import { type BaseClickHouseClientConfigOptions } from '@clickhouse/client-common';
-import type http from 'http';
-import type https from 'node:https';
-import type Stream from 'stream';
+import type { ImplementationDetails } from "@clickhouse/client-common";
+import { type BaseClickHouseClientConfigOptions } from "@clickhouse/client-common";
+import type http from "http";
+import type https from "node:https";
+import type Stream from "stream";
 export type NodeClickHouseClientConfigOptions = BaseClickHouseClientConfigOptions & {
     tls?: BasicTLSOptions | MutualTLSOptions;
     /** HTTP Keep-Alive related settings */
@@ -71,5 +71,5 @@ interface MutualTLSOptions {
     cert: Buffer;
     key: Buffer;
 }
-export declare const NodeConfigImpl: Required<ImplementationDetails<Stream.Readable>['impl']>;
+export declare const NodeConfigImpl: Required<ImplementationDetails<Stream.Readable>["impl"]>;
 export {};

package/dist/config.js

@@ -15,7 +15,7 @@ exports.NodeConfigImpl = {
             urlSearchParamsKeys.forEach((key) => {
                 const value = url.searchParams.get(key);
                 switch (key) {
-                    case 'keep_alive_idle_socket_ttl':
+                    case "keep_alive_idle_socket_ttl":
                         if (nodeConfig.keep_alive === undefined) {
                             nodeConfig.keep_alive = {};
                         }
@@ -40,15 +40,15 @@ exports.NodeConfigImpl = {
     make_connection: (nodeConfig, params) => {
         let tls = undefined;
         if (nodeConfig.tls !== undefined) {
-            if ('cert' in nodeConfig.tls && 'key' in nodeConfig.tls) {
+            if ("cert" in nodeConfig.tls && "key" in nodeConfig.tls) {
                 tls = {
-                    type: 'Mutual',
+                    type: "Mutual",
                     ...nodeConfig.tls,
                 };
             }
             else {
                 tls = {
-                    type: 'Basic',
+                    type: "Basic",
                     ...nodeConfig.tls,
                 };
             }
@@ -70,13 +70,14 @@ exports.NodeConfigImpl = {
         });
     },
     values_encoder: (jsonHandling) => new utils_1.NodeValuesEncoder(jsonHandling),
-    make_result_set: ((stream, format, query_id, log_error, response_headers, jsonHandling) => result_set_1.ResultSet.instance({
+    make_result_set: ((stream, format, query_id, log_error, response_headers, jsonHandling, span) => result_set_1.ResultSet.instance({
         stream,
         format,
         query_id,
         log_error,
         response_headers,
         jsonHandling,
+        span,
     })),
 };
 //# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAMA,6DAIkC;AAIlC,6CAAoE;AACpE,6CAAwC;AACxC,mCAA2C;AA0E9B,QAAA,cAAc,GAEvB;IACF,0BAA0B,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC1C,MAAM,UAAU,GAAsC,EAAE,GAAG,MAAM,EAAE,CAAA;QACnE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;QACvC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAA;QACvC,MAAM,mBAAmB,GAAG,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAA;QACxD,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAW,CAAA;gBACjD,QAAQ,GAAG,EAAE,CAAC;oBACZ,KAAK,4BAA4B;wBAC/B,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;4BACxC,UAAU,CAAC,UAAU,GAAG,EAAE,CAAA;wBAC5B,CAAC;wBACD,UAAU,CAAC,UAAU,CAAC,eAAe,GAAG,IAAA,oCAAoB,EAAC;4BAC3D,GAAG;4BACH,KAAK;4BACL,GAAG,EAAE,CAAC;yBACP,CAAC,CAAA;wBACF,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;wBACtB,MAAK;oBACP;wBACE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBAC1B,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,UAAU;YAClB,cAAc,EAAE,aAAa;YAC7B,cAAc,EAAE,aAAa;SAC9B,CAAA;IACH,CAAC;IACD,eAAe,EAAE,CACf,UAA6C,EAC7C,MAAwB,EACxB,EAAE;QACF,IAAI,GAAG,GAA0B,SAAS,CAAA;QAC1C,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,KAAK,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;gBACxD,GAAG,GAAG;oBACJ,IAAI,EAAE,QAAQ;oBACd,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG;oBACJ,IAAI,EAAE,OAAO;oBACb,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAA;YACH,CAAC;QACH,CAAC;QACD,iEAAiE;QACjE,MAAM,UAAU,GAAG;YACjB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,IAAI,IAAI;YAChD,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,IAAI,IAAI;SACjE,CAAA;QACD,OAAO,kCAAqB,CAAC,MAAM,CAAC;YAClC,iBAAiB,EAAE,MAAM;YACzB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,IAAI,IAAI;YAC/D,4BAA4B,EAC1B,UAAU,CAAC,4BAA4B,IAAI,KAAK;YAClD,6BAA6B,EAC3B,UAAU,CAAC,UAAU,EAAE,6BAA6B,IAAI,KAAK;YAC/D,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,UAAU;YACV,GAAG;YACH,yBAAyB,EAAE,UAAU,CAAC,yBAAyB;SAChE,CAAC,CAAA;IACJ,CAAC;IACD,cAAc,EAAE,CAAC,YAA0B,EAAE,EAAE,CAC7C,IAAI,yBAAiB,CAAC,YAAY,CAAC;IACrC,eAAe,EAAE,CAAC,CAChB,MAAuB,EACvB,MAAkB,EAClB,QAAgB,EAChB,SAA+B,EAC/B,gBAAiC,EACjC,YAA0B,EAC1B,EAAE,CACF,sBAAS,CAAC,QAAQ,CAAC;QACjB,MAAM;QACN,MAAM;QACN,QAAQ;QACR,SAAS;QACT,gBAAgB;QAChB,YAAY;KACb,CAAC,CAAQ;CACb,CAAA"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":";;;AAOA,6DAImC;AAInC,6CAAqE;AACrE,6CAAyC;AACzC,mCAA4C;AA0E/B,QAAA,cAAc,GAEvB;IACF,0BAA0B,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;QAC1C,MAAM,UAAU,GAAsC,EAAE,GAAG,MAAM,EAAE,CAAC;QACpE,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,MAAM,mBAAmB,GAAG,CAAC,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC,CAAC;QACzD,IAAI,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,mBAAmB,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,MAAM,KAAK,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAW,CAAC;gBAClD,QAAQ,GAAG,EAAE,CAAC;oBACZ,KAAK,4BAA4B;wBAC/B,IAAI,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;4BACxC,UAAU,CAAC,UAAU,GAAG,EAAE,CAAC;wBAC7B,CAAC;wBACD,UAAU,CAAC,UAAU,CAAC,eAAe,GAAG,IAAA,oCAAoB,EAAC;4BAC3D,GAAG;4BACH,KAAK;4BACL,GAAG,EAAE,CAAC;yBACP,CAAC,CAAC;wBACH,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;wBACvB,MAAM;oBACR;wBACE,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;gBAC3B,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO;YACL,MAAM,EAAE,UAAU;YAClB,cAAc,EAAE,aAAa;YAC7B,cAAc,EAAE,aAAa;SAC9B,CAAC;IACJ,CAAC;IACD,eAAe,EAAE,CACf,UAA6C,EAC7C,MAAwB,EACxB,EAAE;QACF,IAAI,GAAG,GAA0B,SAAS,CAAC;QAC3C,IAAI,UAAU,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,MAAM,IAAI,UAAU,CAAC,GAAG,IAAI,KAAK,IAAI,UAAU,CAAC,GAAG,EAAE,CAAC;gBACxD,GAAG,GAAG;oBACJ,IAAI,EAAE,QAAQ;oBACd,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,GAAG,GAAG;oBACJ,IAAI,EAAE,OAAO;oBACb,GAAG,UAAU,CAAC,GAAG;iBAClB,CAAC;YACJ,CAAC;QACH,CAAC;QACD,iEAAiE;QACjE,MAAM,UAAU,GAAG;YACjB,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,OAAO,IAAI,IAAI;YAChD,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,eAAe,IAAI,IAAI;SACjE,CAAC;QACF,OAAO,kCAAqB,CAAC,MAAM,CAAC;YAClC,iBAAiB,EAAE,MAAM;YACzB,qBAAqB,EAAE,UAAU,CAAC,qBAAqB,IAAI,IAAI;YAC/D,4BAA4B,EAC1B,UAAU,CAAC,4BAA4B,IAAI,KAAK;YAClD,6BAA6B,EAC3B,UAAU,CAAC,UAAU,EAAE,6BAA6B,IAAI,KAAK;YAC/D,UAAU,EAAE,UAAU,CAAC,UAAU;YACjC,UAAU;YACV,GAAG;YACH,yBAAyB,EAAE,UAAU,CAAC,yBAAyB;SAChE,CAAC,CAAC;IACL,CAAC;IACD,cAAc,EAAE,CAAC,YAA0B,EAAE,EAAE,CAC7C,IAAI,yBAAiB,CAAC,YAAY,CAAC;IACrC,eAAe,EAAE,CAAC,CAChB,MAAuB,EACvB,MAAkB,EAClB,QAAgB,EAChB,SAA+B,EAC/B,gBAAiC,EACjC,YAA0B,EAC1B,IAAqB,EACrB,EAAE,CACF,sBAAS,CAAC,QAAQ,CAAC;QACjB,MAAM;QACN,MAAM;QACN,QAAQ;QACR,SAAS;QACT,gBAAgB;QAChB,YAAY;QACZ,IAAI;KACL,CAAC,CAAQ;CACb,CAAC"}

package/dist/connection/compression.d.ts

@@ -1,7 +1,7 @@
-import type { LogWriter } from '@clickhouse/client-common';
-import { ClickHouseLogLevel } from '@clickhouse/client-common';
-import type Http from 'http';
-import Stream from 'stream';
+import type { LogWriter } from "@clickhouse/client-common";
+import { ClickHouseLogLevel } from "@clickhouse/client-common";
+import type Http from "http";
+import Stream from "stream";
 type DecompressResponseResult = {
     response: Stream.Readable;
 } | {

package/dist/connection/compression.js

@@ -9,14 +9,14 @@ const client_common_1 = require("@clickhouse/client-common");
 const stream_1 = __importDefault(require("stream"));
 const zlib_1 = __importDefault(require("zlib"));
 function decompressResponse(response, log_writer, log_level) {
-    const encoding = response.headers['content-encoding'];
-    if (encoding === 'gzip') {
+    const encoding = response.headers["content-encoding"];
+    if (encoding === "gzip") {
         return {
             response: stream_1.default.pipeline(response, zlib_1.default.createGunzip(), function pipelineCb(err) {
                 if (err) {
                     if (log_level <= client_common_1.ClickHouseLogLevel.ERROR) {
                         log_writer.error({
-                            message: 'An error occurred while decompressing the response',
+                            message: "An error occurred while decompressing the response",
                             err,
                         });
                     }

package/dist/connection/compression.js.map

@@ -1 +1 @@
-{"version":3,"file":"compression.js","sourceRoot":"","sources":["../../src/connection/compression.ts"],"names":[],"mappings":";;;;;AAQA,gDA+BC;AAED,oDAEC;AA1CD,6DAA8D;AAE9D,oDAA2B;AAC3B,gDAAuB;AAIvB,SAAgB,kBAAkB,CAChC,QAA8B,EAC9B,UAAqB,EACrB,SAA6B;IAE7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAErD,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,OAAO;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CACvB,QAAQ,EACR,cAAI,CAAC,YAAY,EAAE,EACnB,SAAS,UAAU,CAAC,GAAG;gBACrB,IAAI,GAAG,EAAE,CAAC;oBACR,IAAI,SAAS,IAAI,kCAAkB,CAAC,KAAK,EAAE,CAAC;wBAC1C,UAAU,CAAC,KAAK,CAAC;4BACf,OAAO,EAAE,oDAAoD;4BAC7D,GAAG;yBACJ,CAAC,CAAA;oBACJ,CAAC;gBACH,CAAC;YACH,CAAC,CACF;SACF,CAAA;IACH,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO;YACL,KAAK,EAAE,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC;SACrD,CAAA;IACH,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,CAAA;AACrB,CAAC;AAED,SAAgB,oBAAoB,CAAC,MAAW;IAC9C,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAA;AACnC,CAAC"}
+{"version":3,"file":"compression.js","sourceRoot":"","sources":["../../src/connection/compression.ts"],"names":[],"mappings":";;;;;AAUA,gDA+BC;AAED,oDAEC;AA5CD,6DAA+D;AAE/D,oDAA4B;AAC5B,gDAAwB;AAMxB,SAAgB,kBAAkB,CAChC,QAA8B,EAC9B,UAAqB,EACrB,SAA6B;IAE7B,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAEtD,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,OAAO;YACL,QAAQ,EAAE,gBAAM,CAAC,QAAQ,CACvB,QAAQ,EACR,cAAI,CAAC,YAAY,EAAE,EACnB,SAAS,UAAU,CAAC,GAAG;gBACrB,IAAI,GAAG,EAAE,CAAC;oBACR,IAAI,SAAS,IAAI,kCAAkB,CAAC,KAAK,EAAE,CAAC;wBAC1C,UAAU,CAAC,KAAK,CAAC;4BACf,OAAO,EAAE,oDAAoD;4BAC7D,GAAG;yBACJ,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC,CACF;SACF,CAAC;IACJ,CAAC;SAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,OAAO;YACL,KAAK,EAAE,IAAI,KAAK,CAAC,wBAAwB,QAAQ,EAAE,CAAC;SACrD,CAAC;IACJ,CAAC;IAED,OAAO,EAAE,QAAQ,EAAE,CAAC;AACtB,CAAC;AAED,SAAgB,oBAAoB,CAAC,MAAW;IAC9C,OAAO,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC;AACpC,CAAC"}

package/dist/connection/create_connection.d.ts

@@ -1,11 +1,11 @@
-import type { ConnectionParams } from '@clickhouse/client-common';
-import type http from 'http';
-import type https from 'node:https';
-import type { NodeBaseConnection, NodeConnectionParams } from './node_base_connection';
+import type { ConnectionParams } from "@clickhouse/client-common";
+import type http from "http";
+import type https from "node:https";
+import type { NodeBaseConnection, NodeConnectionParams } from "./node_base_connection";
 export interface CreateConnectionParams {
     connection_params: ConnectionParams;
-    tls: NodeConnectionParams['tls'];
-    keep_alive: NodeConnectionParams['keep_alive'];
+    tls: NodeConnectionParams["tls"];
+    keep_alive: NodeConnectionParams["keep_alive"];
     http_agent: http.Agent | https.Agent | undefined;
     set_basic_auth_header: boolean;
     capture_enhanced_stack_trace: boolean;

package/dist/connection/create_connection.js

@@ -20,7 +20,7 @@ class NodeConnectionFactory {
             });
         }
         switch (connection_params.url.protocol) {
-            case 'http:':
+            case "http:":
                 return new node_http_connection_1.NodeHttpConnection({
                     ...connection_params,
                     set_basic_auth_header,
@@ -29,7 +29,7 @@ class NodeConnectionFactory {
                     eagerly_destroy_stale_sockets,
                     max_response_headers_size,
                 });
-            case 'https:':
+            case "https:":
                 return new node_https_connection_1.NodeHttpsConnection({
                     ...connection_params,
                     set_basic_auth_header,
@@ -40,7 +40,7 @@ class NodeConnectionFactory {
                     max_response_headers_size,
                 });
             default:
-                throw new Error('Only HTTP and HTTPS protocols are supported');
+                throw new Error("Only HTTP and HTTPS protocols are supported");
         }
     }
 }

package/dist/connection/create_connection.js.map

@@ -1 +1 @@
-{"version":3,"file":"create_connection.js","sourceRoot":"","sources":["../../src/connection/create_connection.ts"],"names":[],"mappings":";;;AAOA,iFAA0E;AAC1E,iEAA2D;AAC3D,mEAA6D;AAa7D,uDAAuD;AACvD,kEAAkE;AAClE,MAAa,qBAAqB;IAChC,MAAM,CAAC,MAAM,CAAC,EACZ,iBAAiB,EACjB,GAAG,EACH,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,6BAA6B,GAAG,KAAK,EACrC,yBAAyB,GACF;QACvB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,wDAAyB,CAAC;gBACnC,GAAG,iBAAiB;gBACpB,qBAAqB;gBACrB,4BAA4B;gBAC5B,UAAU,EAAE,gDAAgD;gBAC5D,UAAU;gBACV,6BAA6B;gBAC7B,yBAAyB;aAC1B,CAAC,CAAA;QACJ,CAAC;QACD,QAAQ,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YACvC,KAAK,OAAO;gBACV,OAAO,IAAI,yCAAkB,CAAC;oBAC5B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;oBACV,6BAA6B;oBAC7B,yBAAyB;iBAC1B,CAAC,CAAA;YACJ,KAAK,QAAQ;gBACX,OAAO,IAAI,2CAAmB,CAAC;oBAC7B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;oBACV,GAAG;oBACH,6BAA6B;oBAC7B,yBAAyB;iBAC1B,CAAC,CAAA;YACJ;gBACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAClE,CAAC;IACH,CAAC;CACF;AA9CD,sDA8CC"}
+{"version":3,"file":"create_connection.js","sourceRoot":"","sources":["../../src/connection/create_connection.ts"],"names":[],"mappings":";;;AAOA,iFAA2E;AAC3E,iEAA4D;AAC5D,mEAA8D;AAa9D,uDAAuD;AACvD,kEAAkE;AAClE,MAAa,qBAAqB;IAChC,MAAM,CAAC,MAAM,CAAC,EACZ,iBAAiB,EACjB,GAAG,EACH,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,4BAA4B,EAC5B,6BAA6B,GAAG,KAAK,EACrC,yBAAyB,GACF;QACvB,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,IAAI,wDAAyB,CAAC;gBACnC,GAAG,iBAAiB;gBACpB,qBAAqB;gBACrB,4BAA4B;gBAC5B,UAAU,EAAE,gDAAgD;gBAC5D,UAAU;gBACV,6BAA6B;gBAC7B,yBAAyB;aAC1B,CAAC,CAAC;QACL,CAAC;QACD,QAAQ,iBAAiB,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;YACvC,KAAK,OAAO;gBACV,OAAO,IAAI,yCAAkB,CAAC;oBAC5B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;oBACV,6BAA6B;oBAC7B,yBAAyB;iBAC1B,CAAC,CAAC;YACL,KAAK,QAAQ;gBACX,OAAO,IAAI,2CAAmB,CAAC;oBAC7B,GAAG,iBAAiB;oBACpB,qBAAqB;oBACrB,4BAA4B;oBAC5B,UAAU;oBACV,GAAG;oBACH,6BAA6B;oBAC7B,yBAAyB;iBAC1B,CAAC,CAAC;YACL;gBACE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;CACF;AA9CD,sDA8CC"}

package/dist/connection/index.d.ts

@@ -1,4 +1,4 @@
-export * from './node_base_connection';
-export * from './node_http_connection';
-export * from './node_https_connection';
-export * from './create_connection';
+export * from "./node_base_connection";
+export * from "./node_http_connection";
+export * from "./node_https_connection";
+export * from "./create_connection";

package/dist/connection/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connection/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAsC;AACtC,yDAAsC;AACtC,0DAAuC;AACvC,sDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connection/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yDAAuC;AACvC,yDAAuC;AACvC,0DAAwC;AACxC,sDAAoC"}

package/dist/connection/node_base_connection.d.ts

@@ -1,10 +1,10 @@
-import type { ConnBaseQueryParams, ConnCommandResult, Connection, ConnectionParams, ConnExecParams, ConnExecResult, ConnInsertParams, ConnInsertResult, ConnPingResult, ConnQueryResult } from '@clickhouse/client-common';
-import { ClickHouseLogLevel } from '@clickhouse/client-common';
-import { type ConnPingParams } from '@clickhouse/client-common';
-import type Http from 'http';
-import type Https from 'node:https';
-import type Stream from 'stream';
-import { type RequestParams } from './socket_pool';
+import type { ConnBaseQueryParams, ConnCommandResult, Connection, ConnectionParams, ConnExecParams, ConnExecResult, ConnInsertParams, ConnInsertResult, ConnPingResult, ConnQueryResult } from "@clickhouse/client-common";
+import { ClickHouseLogLevel } from "@clickhouse/client-common";
+import { type ConnPingParams } from "@clickhouse/client-common";
+import type Http from "http";
+import type Https from "node:https";
+import type Stream from "stream";
+import { type RequestParams } from "./socket_pool";
 export type NodeConnectionParams = ConnectionParams & {
     tls?: TLSParams;
     http_agent?: Http.Agent | Https.Agent;
@@ -31,20 +31,20 @@ export type NodeConnectionParams = ConnectionParams & {
 };
 export type TLSParams = {
     ca_cert: Buffer;
-    type: 'Basic';
+    type: "Basic";
 } | {
     ca_cert: Buffer;
     cert: Buffer;
     key: Buffer;
-    type: 'Mutual';
+    type: "Mutual";
 };
 export declare abstract class NodeBaseConnection implements Connection<Stream.Readable> {
-    protected readonly params: NodeConnectionParams;
-    protected readonly agent: Http.Agent;
     protected readonly defaultAuthHeader: string;
     protected readonly defaultHeaders: Http.OutgoingHttpHeaders;
     private readonly connectionId;
     private readonly socketPool;
+    protected readonly params: NodeConnectionParams;
+    protected readonly agent: Http.Agent;
     protected constructor(params: NodeConnectionParams, agent: Http.Agent);
     ping(params: ConnPingParams): Promise<ConnPingResult>;
     query(params: ConnBaseQueryParams): Promise<ConnQueryResult<Stream.Readable>>;

package/dist/connection/node_base_connection.js

@@ -10,20 +10,20 @@ const utils_1 = require("../utils");
 const stream_1 = require("./stream");
 const socket_pool_1 = require("./socket_pool");
 class NodeBaseConnection {
-    params;
-    agent;
     defaultAuthHeader;
     defaultHeaders;
     connectionId = crypto_1.default.randomUUID();
     socketPool;
+    params;
+    agent;
     constructor(params, agent) {
         this.params = params;
         this.agent = agent;
         this.socketPool = new socket_pool_1.SocketPool(this.connectionId, this.params, this.createClientRequest.bind(this), this.agent);
-        if (params.auth.type === 'Credentials') {
-            this.defaultAuthHeader = `Basic ${Buffer.from(`${params.auth.username}:${params.auth.password}`).toString('base64')}`;
+        if (params.auth.type === "Credentials") {
+            this.defaultAuthHeader = `Basic ${Buffer.from(`${params.auth.username}:${params.auth.password}`).toString("base64")}`;
         }
-        else if (params.auth.type === 'JWT') {
+        else if (params.auth.type === "JWT") {
             this.defaultAuthHeader = `Bearer ${params.auth.access_token}`;
         }
         else {
@@ -31,8 +31,8 @@ class NodeBaseConnection {
         }
         this.defaultHeaders = {
             // Node.js HTTP agent, for some reason, does not set this on its own when KeepAlive is enabled
-            Connection: this.params.keep_alive.enabled ? 'keep-alive' : 'close',
-            'User-Agent': (0, utils_1.getUserAgent)(this.params.application_id),
+            Connection: this.params.keep_alive.enabled ? "keep-alive" : "close",
+            "User-Agent": (0, utils_1.getUserAgent)(this.params.application_id),
         };
     }
     async ping(params) {
@@ -49,29 +49,29 @@ class NodeBaseConnection {
                 });
                 result = await this.request({
                     query: PingQuery,
-                    method: 'GET',
+                    method: "GET",
                     url: (0, client_common_1.transformUrl)({ url: this.params.url, searchParams }),
                     abort_signal: controller.signal,
                     headers: this.buildRequestHeaders(),
                     query_id,
                     log_writer,
                     log_level,
-                }, 'Ping');
+                }, "Ping");
             }
             else {
                 result = await this.request({
-                    query: 'ping',
-                    method: 'GET',
-                    url: (0, client_common_1.transformUrl)({ url: this.params.url, pathname: '/ping' }),
+                    query: "ping",
+                    method: "GET",
+                    url: (0, client_common_1.transformUrl)({ url: this.params.url, pathname: "/ping" }),
                     abort_signal: controller.signal,
                     headers: this.buildRequestHeaders(),
                     query_id,
                     log_writer,
                     log_level,
-                }, 'Ping');
+                }, "Ping");
             }
             await (0, stream_1.drainStreamInternal)({
-                op: 'Ping',
+                op: "Ping",
                 log_writer,
                 query_id,
                 log_level,
@@ -81,11 +81,11 @@ class NodeBaseConnection {
         catch (error) {
             // it is used to ensure that the outgoing request is terminated,
             // and we don't get unhandled error propagation later
-            controller.abort('Ping failed');
+            controller.abort("Ping failed");
             // not an error, as this might be semi-expected
             if (log_level <= client_common_1.ClickHouseLogLevel.WARN) {
                 log_writer.warn({
-                    message: this.httpRequestErrorMessage('Ping'),
+                    message: this.httpRequestErrorMessage("Ping"),
                     err: error,
                     args: {
                         connection_id: this.connectionId,
@@ -106,9 +106,31 @@ class NodeBaseConnection {
         const { log_writer, log_level } = this.params;
         const query_id = this.getQueryId(params.query_id);
         const clickhouse_settings = (0, client_common_1.withHttpSettings)(params.clickhouse_settings, this.params.compression.decompress_response);
+        const queryParams = params.query_params;
+        const hasQueryParams = queryParams !== undefined && Object.keys(queryParams).length > 0;
+        let useMultipart = hasQueryParams &&
+            (params.use_multipart_params ?? this.params.use_multipart_params);
+        // In auto mode, serialize the params for the URL once with an early
+        // return: a null result means they exceed the URL budget and should be
+        // promoted to a multipart body; otherwise the entries are reused below.
+        let urlParamEntries;
+        if (hasQueryParams &&
+            !useMultipart &&
+            (params.use_multipart_params_auto ??
+                this.params.use_multipart_params_auto)) {
+            const entries = (0, client_common_1.serializeQueryParamsForUrl)(queryParams);
+            if (entries === null) {
+                useMultipart = true;
+            }
+            else {
+                urlParamEntries = entries;
+            }
+        }
         const searchParams = (0, client_common_1.toSearchParams)({
             database: this.params.database,
-            query_params: params.query_params,
+            // When using multipart, query_params are sent in the multipart body
+            query_params: useMultipart ? undefined : params.query_params,
+            param_entries: urlParamEntries,
             session_id: params.session_id,
             clickhouse_settings,
             query_id,
@@ -117,19 +139,30 @@ class NodeBaseConnection {
         const { controller, controllerCleanup } = this.getAbortController(params);
         // allows enforcing the compression via the settings even if the client instance has it disabled
         const enableResponseCompression = clickhouse_settings.enable_http_compression === 1;
+        let body = params.query;
+        const headers = this.buildRequestHeaders(params);
+        if (useMultipart && params.query_params !== undefined) {
+            const boundary = `----clickhouse-js-${crypto_1.default.randomUUID()}`;
+            const parts = { query: params.query };
+            for (const [key, value] of Object.entries(params.query_params)) {
+                parts[`param_${key}`] = (0, client_common_1.formatQueryParams)({ value });
+            }
+            body = (0, client_common_1.buildMultipartBody)(parts, boundary);
+            headers["Content-Type"] = `multipart/form-data; boundary=${boundary}`;
+        }
         try {
             const { response_headers, stream, http_status_code } = await this.request({
-                method: 'POST',
+                method: "POST",
                 url: (0, client_common_1.transformUrl)({ url: this.params.url, searchParams }),
-                body: params.query,
+                body,
                 abort_signal: controller.signal,
                 enable_response_compression: enableResponseCompression,
-                headers: this.buildRequestHeaders(params),
+                headers,
                 query: params.query,
                 query_id,
                 log_writer,
                 log_level,
-            }, 'Query');
+            }, "Query");
             return {
                 stream,
                 response_headers,
@@ -138,9 +171,9 @@ class NodeBaseConnection {
             };
         }
         catch (err) {
-            controller.abort('Query HTTP request failed');
+            controller.abort("Query HTTP request failed");
             this.logRequestError({
-                op: 'Query',
+                op: "Query",
                 query_id: query_id,
                 query_params: params,
                 search_params: searchParams,
@@ -171,7 +204,7 @@ class NodeBaseConnection {
         const { controller, controllerCleanup } = this.getAbortController(params);
         try {
             const { stream, summary, response_headers, http_status_code } = await this.request({
-                method: 'POST',
+                method: "POST",
                 url: (0, client_common_1.transformUrl)({ url: this.params.url, searchParams }),
                 body: params.values,
                 abort_signal: controller.signal,
@@ -182,9 +215,9 @@ class NodeBaseConnection {
                 query_id,
                 log_writer,
                 log_level,
-            }, 'Insert');
+            }, "Insert");
             await (0, stream_1.drainStreamInternal)({
-                op: 'Insert',
+                op: "Insert",
                 log_writer,
                 query_id,
                 log_level,
@@ -192,9 +225,9 @@ class NodeBaseConnection {
             return { query_id, summary, response_headers, http_status_code };
         }
         catch (err) {
-            controller.abort('Insert HTTP request failed');
+            controller.abort("Insert HTTP request failed");
             this.logRequestError({
-                op: 'Insert',
+                op: "Insert",
                 query_id: query_id,
                 query_params: params,
                 search_params: searchParams,
@@ -214,7 +247,7 @@ class NodeBaseConnection {
         return this.runExec({
             ...params,
             query_id,
-            op: 'Exec',
+            op: "Exec",
         });
     }
     async command(params) {
@@ -223,9 +256,9 @@ class NodeBaseConnection {
         const commandStartTime = Date.now();
         if (log_level <= client_common_1.ClickHouseLogLevel.TRACE) {
             log_writer.trace({
-                message: 'Command: operation started',
+                message: "Command: operation started",
                 args: {
-                    operation: 'Command',
+                    operation: "Command",
                     connection_id: this.connectionId,
                     query_id,
                 },
@@ -234,14 +267,14 @@ class NodeBaseConnection {
         const { stream, summary, response_headers } = await this.runExec({
             ...params,
             query_id,
-            op: 'Command',
+            op: "Command",
         });
         const runExecDuration = Date.now() - commandStartTime;
         if (log_level <= client_common_1.ClickHouseLogLevel.TRACE) {
             log_writer.trace({
-                message: 'Command: runExec completed, starting stream drain',
+                message: "Command: runExec completed, starting stream drain",
                 args: {
-                    operation: 'Command',
+                    operation: "Command",
                     connection_id: this.connectionId,
                     query_id,
                     runExec_duration_ms: runExecDuration,
@@ -256,7 +289,7 @@ class NodeBaseConnection {
         // ignore the response stream and release the socket immediately
         const drainStartTime = Date.now();
         await (0, stream_1.drainStreamInternal)({
-            op: 'Command',
+            op: "Command",
             log_writer,
             query_id,
             log_level,
@@ -265,9 +298,9 @@ class NodeBaseConnection {
             const drainDuration = Date.now() - drainStartTime;
             const totalDuration = Date.now() - commandStartTime;
             log_writer.trace({
-                message: 'Command: operation completed',
+                message: "Command: operation completed",
                 args: {
-                    operation: 'Command',
+                    operation: "Command",
                     connection_id: this.connectionId,
                     query_id,
                     drain_duration_ms: drainDuration,
@@ -306,7 +339,7 @@ class NodeBaseConnection {
             if ((0, client_common_1.isCredentialsAuth)(params?.auth)) {
                 return {
                     ...headers,
-                    Authorization: `Basic ${Buffer.from(`${params.auth.username}:${params.auth.password}`).toString('base64')}`,
+                    Authorization: `Basic ${Buffer.from(`${params.auth.username}:${params.auth.password}`).toString("base64")}`,
                 };
             }
             else {
@@ -329,11 +362,11 @@ class NodeBaseConnection {
         function onAbort() {
             controller.abort();
         }
-        params.abort_signal?.addEventListener('abort', onAbort);
+        params.abort_signal?.addEventListener("abort", onAbort);
         return {
             controller,
             controllerCleanup: () => {
-                params.abort_signal?.removeEventListener('abort', onAbort);
+                params.abort_signal?.removeEventListener("abort", onAbort);
             },
         };
     }
@@ -372,7 +405,7 @@ class NodeBaseConnection {
         };
         const searchParams = (0, client_common_1.toSearchParams)(toSearchParamsOptions);
         const { controller, controllerCleanup } = this.getAbortController(params);
-        const tryDecompressResponseStream = params.op === 'Exec'
+        const tryDecompressResponseStream = params.op === "Exec"
             ? // allows disabling stream decompression for the `Exec` operation only
                 (params.decompress_response_stream ??
                     this.params.compression.decompress_response)
@@ -382,7 +415,7 @@ class NodeBaseConnection {
         const ignoreErrorResponse = params.ignore_error_response ?? false;
         try {
             const { stream, summary, response_headers, http_status_code } = await this.request({
-                method: 'POST',
+                method: "POST",
                 url: (0, client_common_1.transformUrl)({ url: this.params.url, searchParams }),
                 body: sendQueryInParams ? params.values : params.query,
                 abort_signal: controller.signal,