@clickhouse/client-common 0.2.0-beta1

package/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2016-2023 ClickHouse, Inc.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016-2023 ClickHouse, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,35 @@
+<p align="center">
+<img src=".static/logo.png" width="200px" align="center">
+<h1 align="center">ClickHouse JS client</h1>
+</p>
+<br/>
+<p align="center">
+<a href="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml">
+<img src="https://github.com/ClickHouse/clickhouse-js/actions/workflows/tests.yml/badge.svg?branch=main">
+</a>
+</p>
+
+## About
+
+Official JS client for [ClickHouse](https://clickhouse.com/), written purely in TypeScript,
+thoroughly tested with actual ClickHouse versions.
+
+The repository consists of three packages:
+
+- `@clickhouse/client` - Node.js client, built on top of [HTTP](https://nodejs.org/api/http.html)
+  and [Stream](https://nodejs.org/api/stream.html) APIs; supports streaming for both selects and inserts.
+- `@clickhouse/client-browser` - browser client, built on top of [Fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API)
+  and [Web Streams](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API) APIs; supports streaming for selects.
+- `@clickhouse/common` - shared common types and the base framework for building a custom client implementation.
+
+## Documentation
+
+See the [ClickHouse website](https://clickhouse.com/docs/en/integrations/language-clients/nodejs) for the full documentation entry.
+
+## Usage examples
+
+You can find code samples in the [examples](./examples) folder (with [README](./examples/README.md)).
+
+## Contributing
+
+Check out our [contributing guide](./CONTRIBUTING.md).

package/dist/clickhouse_types.d.ts

@@ -0,0 +1,24 @@
+export interface ResponseJSON<T = unknown> {
+    data: Array<T>;
+    query_id?: string;
+    totals?: Record<string, number>;
+    extremes?: Record<string, any>;
+    meta?: Array<{
+        name: string;
+        type: string;
+    }>;
+    statistics?: {
+        elapsed: number;
+        rows_read: number;
+        bytes_read: number;
+    };
+    rows?: number;
+}
+export interface InputJSON<T = unknown> {
+    meta: {
+        name: string;
+        type: string;
+    }[];
+    data: T[];
+}
+export type InputJSONObjectEachRow<T = unknown> = Record<string, T>;

package/dist/clickhouse_types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clickhouse_types.js.map

package/dist/clickhouse_types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clickhouse_types.js","sourceRoot":"","sources":["../../../packages/client-common/src/clickhouse_types.ts"],"names":[],"mappings":""}

package/dist/client.d.ts

@@ -0,0 +1,149 @@
+import type { ClickHouseLogLevel, ClickHouseSettings, Connection, ConnectionParams, ConnInsertResult, ConnQueryResult, Logger } from '@clickhouse/client-common';
+import { type DataFormat } from '@clickhouse/client-common';
+import type { InputJSON, InputJSONObjectEachRow } from './clickhouse_types';
+import type { BaseResultSet } from './result';
+export type MakeConnection<Stream> = (params: ConnectionParams) => Connection<Stream>;
+export type MakeResultSet<Stream> = (stream: Stream, format: DataFormat, session_id: string) => BaseResultSet<Stream>;
+export interface ValuesEncoder<Stream> {
+    validateInsertValues<T = unknown>(values: InsertValues<Stream, T>, format: DataFormat): void;
+    /**
+     * A function encodes an array or a stream of JSON objects to a format compatible with ClickHouse.
+     * If values are provided as an array of JSON objects, the function encodes it in place.
+     * If values are provided as a stream of JSON objects, the function sets up the encoding of each chunk.
+     * If values are provided as a raw non-object stream, the function does nothing.
+     *
+     * @param values a set of values to send to ClickHouse.
+     * @param format a format to encode value to.
+     */
+    encodeValues<T = unknown>(values: InsertValues<Stream, T>, format: DataFormat): string | Stream;
+}
+export type CloseStream<Stream> = (stream: Stream) => Promise<void>;
+export interface ClickHouseClientConfigOptions<Stream> {
+    impl: {
+        make_connection: MakeConnection<Stream>;
+        make_result_set: MakeResultSet<Stream>;
+        values_encoder: ValuesEncoder<Stream>;
+        close_stream: CloseStream<Stream>;
+    };
+    /** A ClickHouse instance URL. Default value: `http://localhost:8123`. */
+    host?: string;
+    /** The request timeout in milliseconds. Default value: `30_000`. */
+    request_timeout?: number;
+    /** Maximum number of sockets to allow per host. Default value: `Infinity`. */
+    max_open_connections?: number;
+    compression?: {
+        /** `response: true` instructs ClickHouse server to respond with
+         * compressed response body. Default: true. */
+        response?: boolean;
+        /** `request: true` enabled compression on the client request body.
+         * Default: false. */
+        request?: boolean;
+    };
+    /** The name of the user on whose behalf requests are made.
+     * Default: 'default'. */
+    username?: string;
+    /** The user password. Default: ''. */
+    password?: string;
+    /** The name of the application using the nodejs client.
+     * Default: empty. */
+    application?: string;
+    /** Database name to use. Default value: `default`. */
+    database?: string;
+    /** ClickHouse settings to apply to all requests. Default value: {} */
+    clickhouse_settings?: ClickHouseSettings;
+    log?: {
+        /** A class to instantiate a custom logger implementation.
+         * Default: {@link DefaultLogger} */
+        LoggerClass?: new () => Logger;
+        /** Default: OFF */
+        level?: ClickHouseLogLevel;
+    };
+    session_id?: string;
+}
+export type BaseClickHouseClientConfigOptions<Stream> = Omit<ClickHouseClientConfigOptions<Stream>, 'impl'>;
+export interface BaseQueryParams {
+    /** ClickHouse's settings that can be applied on query level. */
+    clickhouse_settings?: ClickHouseSettings;
+    /** Parameters for query binding. https://clickhouse.com/docs/en/interfaces/http/#cli-queries-with-parameters */
+    query_params?: Record<string, unknown>;
+    /** AbortSignal instance to cancel a request in progress. */
+    abort_signal?: AbortSignal;
+    /** A specific `query_id` that will be sent with this request.
+     * If it is not set, a random identifier will be generated automatically by the client. */
+    query_id?: string;
+    session_id?: string;
+}
+export interface QueryParams extends BaseQueryParams {
+    /** Statement to execute. */
+    query: string;
+    /** Format of the resulting dataset. */
+    format?: DataFormat;
+}
+export interface ExecParams extends BaseQueryParams {
+    /** Statement to execute. */
+    query: string;
+}
+export type CommandParams = ExecParams;
+export interface CommandResult {
+    query_id: string;
+}
+export type InsertResult = ConnInsertResult;
+export type ExecResult<Stream> = ConnQueryResult<Stream>;
+export type InsertValues<Stream, T = unknown> = ReadonlyArray<T> | Stream | InputJSON<T> | InputJSONObjectEachRow<T>;
+export interface InsertParams<Stream = unknown, T = unknown> extends BaseQueryParams {
+    /** Name of a table to insert into. */
+    table: string;
+    /** A dataset to insert. */
+    values: InsertValues<Stream, T>;
+    /** Format of the dataset to insert. */
+    format?: DataFormat;
+}
+export declare class ClickHouseClient<Stream = unknown> {
+    private readonly connectionParams;
+    private readonly connection;
+    private readonly makeResultSet;
+    private readonly valuesEncoder;
+    private readonly closeStream;
+    private readonly sessionId?;
+    constructor(config: ClickHouseClientConfigOptions<Stream>);
+    private getQueryParams;
+    /**
+     * Used for most statements that can have a response, such as SELECT.
+     * FORMAT clause should be specified separately via {@link QueryParams.format} (default is JSON)
+     * Consider using {@link ClickHouseClient.insert} for data insertion,
+     * or {@link ClickHouseClient.command} for DDLs.
+     */
+    query(params: QueryParams): Promise<BaseResultSet<Stream>>;
+    /**
+     * It should be used for statements that do not have any output,
+     * when the format clause is not applicable, or when you are not interested in the response at all.
+     * Response stream is destroyed immediately as we do not expect useful information there.
+     * Examples of such statements are DDLs or custom inserts.
+     * If you are interested in the response data, consider using {@link ClickHouseClient.exec}
+     */
+    command(params: CommandParams): Promise<CommandResult>;
+    /**
+     * Similar to {@link ClickHouseClient.command}, but for the cases where the output is expected,
+     * but format clause is not applicable. The caller of this method is expected to consume the stream,
+     * otherwise, the request will eventually be timed out.
+     */
+    exec(params: ExecParams): Promise<ExecResult<Stream>>;
+    /**
+     * The primary method for data insertion. It is recommended to avoid arrays in case of large inserts
+     * to reduce application memory consumption and consider streaming for most of such use cases.
+     * As the insert operation does not provide any output, the response stream is immediately destroyed.
+     * In case of a custom insert operation, such as, for example, INSERT FROM SELECT,
+     * consider using {@link ClickHouseClient.command}, passing the entire raw query there (including FORMAT clause).
+     */
+    insert<T>(params: InsertParams<Stream, T>): Promise<InsertResult>;
+    /**
+     * Health-check request. Can throw an error if the connection is refused.
+     */
+    ping(): Promise<boolean>;
+    /**
+     * Shuts down the underlying connection.
+     * This method should ideally be called only once per application lifecycle,
+     * for example, during the graceful shutdown phase.
+     */
+    close(): Promise<void>;
+}

package/dist/client.js

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClickHouseClient = void 0;
+const client_common_1 = require("@clickhouse/client-common");
+function validateConnectionParams({ url }) {
+    if (url.protocol !== 'http:' && url.protocol !== 'https:') {
+        throw new Error(`Only http(s) protocol is supported, but given: [${url.protocol}]`);
+    }
+}
+function createUrl(host) {
+    try {
+        return new URL(host);
+    }
+    catch (err) {
+        throw new Error('Configuration parameter "host" contains malformed url.');
+    }
+}
+function getConnectionParams(config) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+    return {
+        application_id: config.application,
+        url: createUrl((_a = config.host) !== null && _a !== void 0 ? _a : 'http://localhost:8123'),
+        request_timeout: (_b = config.request_timeout) !== null && _b !== void 0 ? _b : 300000,
+        max_open_connections: (_c = config.max_open_connections) !== null && _c !== void 0 ? _c : Infinity,
+        compression: {
+            decompress_response: (_e = (_d = config.compression) === null || _d === void 0 ? void 0 : _d.response) !== null && _e !== void 0 ? _e : true,
+            compress_request: (_g = (_f = config.compression) === null || _f === void 0 ? void 0 : _f.request) !== null && _g !== void 0 ? _g : false,
+        },
+        username: (_h = config.username) !== null && _h !== void 0 ? _h : 'default',
+        password: (_j = config.password) !== null && _j !== void 0 ? _j : '',
+        database: (_k = config.database) !== null && _k !== void 0 ? _k : 'default',
+        clickhouse_settings: (_l = config.clickhouse_settings) !== null && _l !== void 0 ? _l : {},
+        logWriter: new client_common_1.LogWriter(((_m = config === null || config === void 0 ? void 0 : config.log) === null || _m === void 0 ? void 0 : _m.LoggerClass)
+            ? new config.log.LoggerClass()
+            : new client_common_1.DefaultLogger(), (_o = config.log) === null || _o === void 0 ? void 0 : _o.level),
+    };
+}
+class ClickHouseClient {
+    constructor(config) {
+        Object.defineProperty(this, "connectionParams", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "connection", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "makeResultSet", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "valuesEncoder", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "closeStream", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sessionId", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.connectionParams = getConnectionParams(config);
+        this.sessionId = config.session_id;
+        validateConnectionParams(this.connectionParams);
+        this.connection = config.impl.make_connection(this.connectionParams);
+        this.makeResultSet = config.impl.make_result_set;
+        this.valuesEncoder = config.impl.values_encoder;
+        this.closeStream = config.impl.close_stream;
+    }
+    getQueryParams(params) {
+        return {
+            clickhouse_settings: {
+                ...this.connectionParams.clickhouse_settings,
+                ...params.clickhouse_settings,
+            },
+            query_params: params.query_params,
+            abort_signal: params.abort_signal,
+            query_id: params.query_id,
+            session_id: this.sessionId,
+        };
+    }
+    /**
+     * Used for most statements that can have a response, such as SELECT.
+     * FORMAT clause should be specified separately via {@link QueryParams.format} (default is JSON)
+     * Consider using {@link ClickHouseClient.insert} for data insertion,
+     * or {@link ClickHouseClient.command} for DDLs.
+     */
+    async query(params) {
+        var _a;
+        const format = (_a = params.format) !== null && _a !== void 0 ? _a : 'JSON';
+        const query = formatQuery(params.query, format);
+        const { stream, query_id } = await this.connection.query({
+            query,
+            ...this.getQueryParams(params),
+        });
+        return this.makeResultSet(stream, format, query_id);
+    }
+    /**
+     * It should be used for statements that do not have any output,
+     * when the format clause is not applicable, or when you are not interested in the response at all.
+     * Response stream is destroyed immediately as we do not expect useful information there.
+     * Examples of such statements are DDLs or custom inserts.
+     * If you are interested in the response data, consider using {@link ClickHouseClient.exec}
+     */
+    async command(params) {
+        const { stream, query_id } = await this.exec(params);
+        await this.closeStream(stream);
+        return { query_id };
+    }
+    /**
+     * Similar to {@link ClickHouseClient.command}, but for the cases where the output is expected,
+     * but format clause is not applicable. The caller of this method is expected to consume the stream,
+     * otherwise, the request will eventually be timed out.
+     */
+    async exec(params) {
+        const query = removeTrailingSemi(params.query.trim());
+        return await this.connection.exec({
+            query,
+            ...this.getQueryParams(params),
+        });
+    }
+    /**
+     * The primary method for data insertion. It is recommended to avoid arrays in case of large inserts
+     * to reduce application memory consumption and consider streaming for most of such use cases.
+     * As the insert operation does not provide any output, the response stream is immediately destroyed.
+     * In case of a custom insert operation, such as, for example, INSERT FROM SELECT,
+     * consider using {@link ClickHouseClient.command}, passing the entire raw query there (including FORMAT clause).
+     */
+    async insert(params) {
+        const format = params.format || 'JSONCompactEachRow';
+        this.valuesEncoder.validateInsertValues(params.values, format);
+        const query = `INSERT INTO ${params.table.trim()} FORMAT ${format}`;
+        return await this.connection.insert({
+            query,
+            values: this.valuesEncoder.encodeValues(params.values, format),
+            ...this.getQueryParams(params),
+        });
+    }
+    /**
+     * Health-check request. Can throw an error if the connection is refused.
+     */
+    async ping() {
+        return await this.connection.ping();
+    }
+    /**
+     * Shuts down the underlying connection.
+     * This method should ideally be called only once per application lifecycle,
+     * for example, during the graceful shutdown phase.
+     */
+    async close() {
+        return await this.connection.close();
+    }
+}
+exports.ClickHouseClient = ClickHouseClient;
+function formatQuery(query, format) {
+    query = query.trim();
+    query = removeTrailingSemi(query);
+    return query + ' \nFORMAT ' + format;
+}
+function removeTrailingSemi(query) {
+    let lastNonSemiIdx = query.length;
+    for (let i = lastNonSemiIdx; i > 0; i--) {
+        if (query[i - 1] !== ';') {
+            lastNonSemiIdx = i;
+            break;
+        }
+    }
+    if (lastNonSemiIdx !== query.length) {
+        return query.slice(0, lastNonSemiIdx);
+    }
+    return query;
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../packages/client-common/src/client.ts"],"names":[],"mappings":";;;AASA,6DAIkC;AAuIlC,SAAS,wBAAwB,CAAC,EAAE,GAAG,EAAoB;IACzD,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE;QACzD,MAAM,IAAI,KAAK,CACb,mDAAmD,GAAG,CAAC,QAAQ,GAAG,CACnE,CAAA;KACF;AACH,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,IAAI;QACF,OAAO,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;KACrB;IAAC,OAAO,GAAG,EAAE;QACZ,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;KAC1E;AACH,CAAC;AAED,SAAS,mBAAmB,CAC1B,MAA6C;;IAE7C,OAAO;QACL,cAAc,EAAE,MAAM,CAAC,WAAW;QAClC,GAAG,EAAE,SAAS,CAAC,MAAA,MAAM,CAAC,IAAI,mCAAI,uBAAuB,CAAC;QACtD,eAAe,EAAE,MAAA,MAAM,CAAC,eAAe,mCAAI,MAAO;QAClD,oBAAoB,EAAE,MAAA,MAAM,CAAC,oBAAoB,mCAAI,QAAQ;QAC7D,WAAW,EAAE;YACX,mBAAmB,EAAE,MAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,QAAQ,mCAAI,IAAI;YACzD,gBAAgB,EAAE,MAAA,MAAA,MAAM,CAAC,WAAW,0CAAE,OAAO,mCAAI,KAAK;SACvD;QACD,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,SAAS;QACtC,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,EAAE;QAC/B,QAAQ,EAAE,MAAA,MAAM,CAAC,QAAQ,mCAAI,SAAS;QACtC,mBAAmB,EAAE,MAAA,MAAM,CAAC,mBAAmB,mCAAI,EAAE;QACrD,SAAS,EAAE,IAAI,yBAAS,CACtB,CAAA,MAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,0CAAE,WAAW;YACtB,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE;YAC9B,CAAC,CAAC,IAAI,6BAAa,EAAE,EACvB,MAAA,MAAM,CAAC,GAAG,0CAAE,KAAK,CAClB;KACF,CAAA;AACH,CAAC;AAED,MAAa,gBAAgB;IAQ3B,YAAY,MAA6C;QAPzD;;;;;WAAmD;QACnD;;;;;WAA+C;QAC/C;;;;;WAAqD;QACrD;;;;;WAAqD;QACrD;;;;;WAAiD;QACjD;;;;;WAAmC;QAGjC,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAC,MAAM,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,UAAU,CAAA;QAClC,wBAAwB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QAC/C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;QACpE,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAA;QAChD,IAAI,CAAC,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAA;IAC7C,CAAC;IAEO,cAAc,CAAC,MAAuB;QAC5C,OAAO;YACL,mBAAmB,EAAE;gBACnB,GAAG,IAAI,CAAC,gBAAgB,CAAC,mBAAmB;gBAC5C,GAAG,MAAM,CAAC,mBAAmB;aAC9B;YACD,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,YAAY,EAAE,MAAM,CAAC,YAAY;YACjC,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,UAAU,EAAE,IAAI,CAAC,SAAS;SAC3B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,KAAK,CAAC,MAAmB;;QAC7B,MAAM,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,MAAM,CAAA;QACtC,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;QAC/C,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;YACvD,KAAK;YACL,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;QACF,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAA;IACrD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,MAAqB;QACjC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpD,MAAM,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAC9B,OAAO,EAAE,QAAQ,EAAE,CAAA;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,MAAkB;QAC3B,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAA;QACrD,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YAChC,KAAK;YACL,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,CAAI,MAA+B;QAC7C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,oBAAoB,CAAA;QAEpD,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;QAC9D,MAAM,KAAK,GAAG,eAAe,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,MAAM,EAAE,CAAA;QAEnE,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAClC,KAAK;YACL,MAAM,EAAE,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;YAC9D,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAA;IACrC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAA;IACtC,CAAC;CACF;AA5GD,4CA4GC;AAED,SAAS,WAAW,CAAC,KAAa,EAAE,MAAkB;IACpD,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAA;IACpB,KAAK,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IACjC,OAAO,KAAK,GAAG,YAAY,GAAG,MAAM,CAAA;AACtC,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAa;IACvC,IAAI,cAAc,GAAG,KAAK,CAAC,MAAM,CAAA;IACjC,KAAK,IAAI,CAAC,GAAG,cAAc,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE;QACvC,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;YACxB,cAAc,GAAG,CAAC,CAAA;YAClB,MAAK;SACN;KACF;IACD,IAAI,cAAc,KAAK,KAAK,CAAC,MAAM,EAAE;QACnC,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;KACtC;IACD,OAAO,KAAK,CAAA;AACd,CAAC"}

package/dist/connection.d.ts

@@ -0,0 +1,44 @@
+import type { LogWriter } from './logger';
+import type { ClickHouseSettings } from './settings';
+export interface ConnectionParams {
+    url: URL;
+    request_timeout: number;
+    max_open_connections: number;
+    compression: {
+        decompress_response: boolean;
+        compress_request: boolean;
+    };
+    username: string;
+    password: string;
+    database: string;
+    clickhouse_settings: ClickHouseSettings;
+    logWriter: LogWriter;
+    application_id?: string;
+}
+export interface ConnBaseQueryParams {
+    query: string;
+    clickhouse_settings?: ClickHouseSettings;
+    query_params?: Record<string, unknown>;
+    abort_signal?: AbortSignal;
+    session_id?: string;
+    query_id?: string;
+}
+export interface ConnInsertParams<Stream> extends ConnBaseQueryParams {
+    values: string | Stream;
+}
+export interface ConnBaseResult {
+    query_id: string;
+}
+export interface ConnQueryResult<Stream> extends ConnBaseResult {
+    stream: Stream;
+    query_id: string;
+}
+export type ConnInsertResult = ConnBaseResult;
+export type ConnExecResult<Stream> = ConnQueryResult<Stream>;
+export interface Connection<Stream> {
+    ping(): Promise<boolean>;
+    close(): Promise<void>;
+    query(params: ConnBaseQueryParams): Promise<ConnQueryResult<Stream>>;
+    exec(params: ConnBaseQueryParams): Promise<ConnExecResult<Stream>>;
+    insert(params: ConnInsertParams<Stream>): Promise<ConnInsertResult>;
+}

package/dist/connection.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=connection.js.map

package/dist/connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.js","sourceRoot":"","sources":["../../../packages/client-common/src/connection.ts"],"names":[],"mappings":""}