@clickhouse/client 1.22.0 → 1.23.0-head.c8dc8d8.1

package/dist/common/logger.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClickHouseLogLevel = exports.LogWriter = exports.DefaultLogger = void 0;
+class DefaultLogger {
+    trace({ module, message, args }) {
+        const params = [
+            formatMessage({ module, message, level: "TRACE" }),
+        ];
+        if (args) {
+            params.push("\nArguments:", args);
+        }
+        console.debug(...params);
+    }
+    debug({ module, message, args }) {
+        const params = [
+            formatMessage({ module, message, level: "DEBUG" }),
+        ];
+        if (args) {
+            params.push("\nArguments:", args);
+        }
+        console.debug(...params);
+    }
+    info({ module, message, args }) {
+        const params = [
+            formatMessage({ module, message, level: "INFO" }),
+        ];
+        if (args) {
+            params.push("\nArguments:", args);
+        }
+        console.info(...params);
+    }
+    warn({ module, message, args, err }) {
+        const params = [
+            formatMessage({ module, message, level: "WARN" }),
+        ];
+        if (args) {
+            params.push("\nArguments:", args);
+        }
+        if (err) {
+            params.push("\nCaused by:", err);
+        }
+        console.warn(...params);
+    }
+    error({ module, message, args, err }) {
+        const params = [
+            formatMessage({ module, message, level: "ERROR" }),
+        ];
+        if (args) {
+            params.push("\nArguments:", args);
+        }
+        params.push("\nCaused by:", err);
+        console.error(...params);
+    }
+}
+exports.DefaultLogger = DefaultLogger;
+class LogWriter {
+    logger;
+    module;
+    logLevel;
+    constructor(logger, module, logLevel) {
+        this.logger = logger;
+        this.module = module;
+        this.logLevel = logLevel;
+        this.info({
+            message: `Log level is set to ${exports.ClickHouseLogLevel[this.logLevel]}`,
+        });
+    }
+    trace(params) {
+        if (this.logLevel <= exports.ClickHouseLogLevel.TRACE) {
+            this.logger.trace({
+                ...params,
+                module: params.module ?? this.module,
+            });
+        }
+    }
+    debug(params) {
+        if (this.logLevel <= exports.ClickHouseLogLevel.DEBUG) {
+            this.logger.debug({
+                ...params,
+                module: params.module ?? this.module,
+            });
+        }
+    }
+    info(params) {
+        if (this.logLevel <= exports.ClickHouseLogLevel.INFO) {
+            this.logger.info({
+                ...params,
+                module: params.module ?? this.module,
+            });
+        }
+    }
+    warn(params) {
+        if (this.logLevel <= exports.ClickHouseLogLevel.WARN) {
+            this.logger.warn({
+                ...params,
+                module: params.module ?? this.module,
+            });
+        }
+    }
+    error(params) {
+        if (this.logLevel <= exports.ClickHouseLogLevel.ERROR) {
+            this.logger.error({
+                ...params,
+                module: params.module ?? this.module,
+            });
+        }
+    }
+}
+exports.LogWriter = LogWriter;
+/**
+ * Mimics the runtime shape of a numeric TypeScript `enum`: an object with both
+ * forward (`Name -> number`) and reverse (`number -> Name`) mappings. This
+ * preserves backwards compatibility with the previous `enum ClickHouseLogLevel`
+ * — both `ClickHouseLogLevel.TRACE` (returns `0`) and `ClickHouseLogLevel[0]`
+ * (returns `'TRACE'`) continue to work — while staying compatible with the
+ * `--erasableSyntaxOnly` TypeScript option (no TS `enum` declaration).
+ */
+exports.ClickHouseLogLevel = {
+    /**
+     * A fine-grained debugging event. Might produce a lot of logs, so use with caution.
+     */
+    TRACE: 0,
+    /**
+     * A debugging event. Useful for debugging, but generally not needed in production. Includes technical values that might require redacting.
+     */
+    DEBUG: 1,
+    /**
+     * An informational event. Indicates that an event happened.
+     */
+    INFO: 2,
+    /**
+     * A warning event. Not an error, but is likely more important than an informational event. Addressing should help prevent potential issues.
+     */
+    WARN: 3,
+    /**
+     * An error event. Something went wrong.
+     */
+    ERROR: 4,
+    /**
+     * Logging is turned off.
+     */
+    OFF: 127,
+    0: "TRACE",
+    1: "DEBUG",
+    2: "INFO",
+    3: "WARN",
+    4: "ERROR",
+    127: "OFF",
+};
+function formatMessage({ level, module, message, }) {
+    const ts = new Date().toISOString();
+    return `[${ts}][${level}][@clickhouse/client][${module}] ${message}`;
+}
+//# sourceMappingURL=logger.js.map

package/dist/common/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/common/logger.ts"],"names":[],"mappings":";;;AAgBA,MAAa,aAAa;IACxB,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACxC,MAAM,MAAM,GAAc;YACxB,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;SACnD,CAAC;QACF,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACxC,MAAM,MAAM,GAAc;YACxB,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;SACnD,CAAC;QACF,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAa;QACvC,MAAM,MAAM,GAAc;YACxB,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;SAClD,CAAC;QACF,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAiB;QAChD,MAAM,MAAM,GAAc;YACxB,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;SAClD,CAAC;QACF,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,EAAkB;QAClD,MAAM,MAAM,GAAc;YACxB,aAAa,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;SACnD,CAAC;QACF,IAAI,IAAI,EAAE,CAAC;YACT,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,cAAc,EAAE,GAAG,CAAC,CAAC;QACjC,OAAO,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC;IAC3B,CAAC;CACF;AAtDD,sCAsDC;AAOD,MAAa,SAAS;IACH,MAAM,CAAS;IACf,MAAM,CAAS;IACf,QAAQ,CAAqB;IAC9C,YAAY,MAAc,EAAE,MAAc,EAAE,QAA4B;QACtE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,IAAI,CAAC;YACR,OAAO,EAAE,uBAAuB,0BAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;SACpE,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAgC;QACpC,IAAI,IAAI,CAAC,QAAQ,IAAK,0BAAkB,CAAC,KAAgB,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,GAAG,MAAM;gBACT,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAgC;QACpC,IAAI,IAAI,CAAC,QAAQ,IAAK,0BAAkB,CAAC,KAAgB,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,GAAG,MAAM;gBACT,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAA+B;QAClC,IAAI,IAAI,CAAC,QAAQ,IAAK,0BAAkB,CAAC,IAAe,EAAE,CAAC;YACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,GAAG,MAAM;gBACT,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,IAAI,CAAC,MAA+B;QAClC,IAAI,IAAI,CAAC,QAAQ,IAAK,0BAAkB,CAAC,IAAe,EAAE,CAAC;YACzD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;gBACf,GAAG,MAAM;gBACT,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAgC;QACpC,IAAI,IAAI,CAAC,QAAQ,IAAK,0BAAkB,CAAC,KAAgB,EAAE,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;gBAChB,GAAG,MAAM;gBACT,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM;aACrC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AAzDD,8BAyDC;AAED;;;;;;;GAOG;AACU,QAAA,kBAAkB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,CAAC;IACR;;OAEG;IACH,KAAK,EAAE,CAAC;IACR;;OAEG;IACH,IAAI,EAAE,CAAC;IACP;;OAEG;IACH,IAAI,EAAE,CAAC;IACP;;OAEG;IACH,KAAK,EAAE,CAAC;IACR;;OAEG;IACH,GAAG,EAAE,GAAG;IACR,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,OAAO;IACV,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,MAAM;IACT,CAAC,EAAE,OAAO;IACV,GAAG,EAAE,KAAK;CACF,CAAC;AAGX,SAAS,aAAa,CAAC,EACrB,KAAK,EACL,MAAM,EACN,OAAO,GAKR;IACC,MAAM,EAAE,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACpC,OAAO,IAAI,EAAE,KAAK,KAAK,yBAAyB,MAAM,KAAK,OAAO,EAAE,CAAC;AACvE,CAAC"}

package/dist/common/parse/column_types.d.ts

@@ -0,0 +1,127 @@
+export declare class ColumnTypeParseError extends Error {
+    readonly args: Record<string, unknown>;
+    constructor(message: string, args?: Record<string, unknown>);
+}
+export declare const SimpleColumnTypes: readonly ["Bool", "UInt8", "Int8", "UInt16", "Int16", "UInt32", "Int32", "UInt64", "Int64", "UInt128", "Int128", "UInt256", "Int256", "Float32", "Float64", "String", "UUID", "Date", "Date32", "IPv4", "IPv6"];
+export type SimpleColumnType = (typeof SimpleColumnTypes)[number];
+export interface ParsedColumnSimple {
+    type: "Simple";
+    /** Without LowCardinality and Nullable. For example:
+     *  * UInt8 -> UInt8
+     *  * LowCardinality(Nullable(String)) -> String */
+    columnType: SimpleColumnType;
+    /** The original type before parsing. */
+    sourceType: string;
+}
+export interface ParsedColumnFixedString {
+    type: "FixedString";
+    sizeBytes: number;
+    sourceType: string;
+}
+export interface ParsedColumnDateTime {
+    type: "DateTime";
+    timezone: string | null;
+    sourceType: string;
+}
+export interface ParsedColumnDateTime64 {
+    type: "DateTime64";
+    timezone: string | null;
+    /** Valid range: [0 : 9] */
+    precision: number;
+    sourceType: string;
+}
+export interface ParsedColumnEnum {
+    type: "Enum";
+    /** Index to name */
+    values: Record<number, string>;
+    /** UInt8 or UInt16 */
+    intSize: 8 | 16;
+    sourceType: string;
+}
+/** Int size for Decimal depends on the Precision
+ *  * 32 bits  for precision <  10
+ *  * 64 bits  for precision <  19
+ *  * 128 bits for precision <  39
+ *  * 256 bits for precision >= 39
+ */
+export interface DecimalParams {
+    precision: number;
+    scale: number;
+    intSize: 32 | 64 | 128 | 256;
+}
+export interface ParsedColumnDecimal {
+    type: "Decimal";
+    params: DecimalParams;
+    sourceType: string;
+}
+/** Tuple, Array or Map itself cannot be Nullable */
+export interface ParsedColumnNullable {
+    type: "Nullable";
+    value: ParsedColumnSimple | ParsedColumnEnum | ParsedColumnDecimal | ParsedColumnFixedString | ParsedColumnDateTime | ParsedColumnDateTime64;
+    sourceType: string;
+}
+/** Array cannot be Nullable or LowCardinality, but its value type can be.
+ *  Arrays can be multidimensional, e.g. Array(Array(Array(T))).
+ *  Arrays are allowed to have a Map as the value type.
+ */
+export interface ParsedColumnArray {
+    type: "Array";
+    value: ParsedColumnNullable | ParsedColumnSimple | ParsedColumnFixedString | ParsedColumnDecimal | ParsedColumnEnum | ParsedColumnMap | ParsedColumnDateTime | ParsedColumnDateTime64 | ParsedColumnTuple;
+    /** Array(T) = 1 dimension, Array(Array(T)) = 2, etc. */
+    dimensions: number;
+    sourceType: string;
+}
+/** @see https://clickhouse.com/docs/en/sql-reference/data-types/map */
+export interface ParsedColumnMap {
+    type: "Map";
+    /** Possible key types:
+     *  - String, Integer, UUID, Date, Date32, etc ({@link ParsedColumnSimple})
+     *  - FixedString
+     *  - DateTime
+     *  - Enum
+     */
+    key: ParsedColumnSimple | ParsedColumnFixedString | ParsedColumnEnum | ParsedColumnDateTime;
+    /** Value types are arbitrary, including Map, Array, and Tuple. */
+    value: ParsedColumnType;
+    sourceType: string;
+}
+export interface ParsedColumnTuple {
+    type: "Tuple";
+    /** Element types are arbitrary, including Map, Array, and Tuple. */
+    elements: ParsedColumnType[];
+    sourceType: string;
+}
+export type ParsedColumnType = ParsedColumnSimple | ParsedColumnEnum | ParsedColumnFixedString | ParsedColumnNullable | ParsedColumnDecimal | ParsedColumnDateTime | ParsedColumnDateTime64 | ParsedColumnArray | ParsedColumnTuple | ParsedColumnMap;
+/**
+ * @experimental - incomplete, unstable API;
+ * originally intended to be used for RowBinary/Native header parsing internally.
+ * Currently unsupported source types:
+ * * Geo
+ * * (Simple)AggregateFunction
+ * * Nested
+ * * Old/new JSON
+ * * Dynamic
+ * * Variant
+ */
+export declare function parseColumnType(sourceType: string): ParsedColumnType;
+export declare function parseDecimalType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnDecimal;
+export declare function parseEnumType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnEnum;
+export declare function parseMapType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnMap;
+export declare function parseTupleType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnTuple;
+export declare function parseArrayType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnArray;
+export declare function parseDateTimeType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnDateTime;
+export declare function parseDateTime64Type({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnDateTime64;
+export declare function parseFixedStringType({ columnType, sourceType, }: ParseColumnTypeParams): ParsedColumnFixedString;
+export declare function asNullableType(value: ParsedColumnType, sourceType: string): ParsedColumnNullable;
+/** Used for Map key/value types and Tuple elements.
+ *  * `String, UInt8` results in [`String`, `UInt8`].
+ *  * `String, UInt8, Array(String)` results in [`String`, `UInt8`, `Array(String)`].
+ *  * Throws if parsed values are below the required minimum. */
+export declare function getElementsTypes({ columnType, sourceType }: ParseColumnTypeParams, minElements: number): string[];
+interface ParseColumnTypeParams {
+    /** A particular type to parse, such as DateTime. */
+    columnType: string;
+    /** Full type definition, such as Map(String, DateTime). */
+    sourceType: string;
+}
+export {};