ts-prorm-orm 1.1.0 → 1.2.1

package/dist/dialects/clickhouse/index.js

@@ -40,7 +40,23 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClickHouseDialect = void 0;
 exports.createClickHouseDialect = createClickHouseDialect;
-const client_1 = require("@clickhouse/client");
+// Lazily-loaded `@clickhouse/client` module. The native/runtime driver is only
+// required the first time a connection is opened, so merely importing this ORM
+// never pulls in the ClickHouse driver.
+let clickhouseModule = null;
+function loadClickHouse() {
+    if (!clickhouseModule) {
+        try {
+            clickhouseModule = require('@clickhouse/client');
+        }
+        catch (err) {
+            throw new Error("The '@clickhouse/client' package is required to use the ClickHouse dialect but could not be loaded. " +
+                'Install it with `npm install @clickhouse/client`. Original error: ' +
+                (err instanceof Error ? err.message : String(err)));
+        }
+    }
+    return clickhouseModule;
+}
 const query_stream_helper_1 = require("../query-stream-helper");
 const prorm_1 = require("../../prorm");
 /**
@@ -68,7 +84,7 @@ class ClickHouseDialect {
     // ==================== Connection ====================
     async connect() {
         try {
-            this.client = (0, client_1.createClient)({
+            this.client = loadClickHouse().createClient({
                 url: `${this.config.protocol}://${this.config.host}:${this.config.port}`,
                 username: this.config.username,
                 password: this.config.password,
@@ -728,6 +744,95 @@ class ClickHouseDialect {
         const result = await this.query(`SELECT name FROM system.tables WHERE database = currentDatabase() AND engine IN ('View', 'MaterializedView') ORDER BY name`);
         return result.rows.map((row) => row.name);
     }
+    // ==================== OPTIMIZE (ReplacingMergeTree dedup / compaction) ====================
+    /**
+     * Run `OPTIMIZE TABLE <t> [PARTITION ...] [FINAL] [DEDUPLICATE [BY ...]]` —
+     * ClickHouse's on-demand merge trigger. This is the *write-side* counterpart
+     * to reading with `FINAL`: it forces the background merge that collapses
+     * ReplacingMergeTree/CollapsingMergeTree rows to their final state so that
+     * ordinary (non-`FINAL`) reads see deduplicated data.
+     *
+     * Prefer this after a batch of ReplacingMergeTree "upserts" (which are plain
+     * INSERTs — see {@link buildUpsertQuery}) when you want subsequent reads to be
+     * clean without paying the per-query `FINAL` merge-on-read cost. Note
+     * `OPTIMIZE` is heavy and not guaranteed to merge everything in one pass on
+     * very large tables; `FINAL` on the read is the guaranteed-correct fallback.
+     *
+     * @param options.final - append `FINAL` (merge even a single existing part).
+     * @param options.deduplicate - append `DEDUPLICATE` (drop fully-identical rows).
+     * @param options.deduplicateBy - column list for `DEDUPLICATE BY (...)`.
+     * @param options.partition - restrict to a single partition (`PARTITION <expr>`).
+     */
+    async optimizeTable(tableName, options) {
+        let sql = `OPTIMIZE TABLE ${this.quoteTable(tableName)}`;
+        if (options?.partition) {
+            sql += ` PARTITION ${options.partition}`;
+        }
+        if (options?.final) {
+            sql += ' FINAL';
+        }
+        if (options?.deduplicate || (options?.deduplicateBy && options.deduplicateBy.length > 0)) {
+            sql += ' DEDUPLICATE';
+            if (options?.deduplicateBy && options.deduplicateBy.length > 0) {
+                sql += ` BY ${options.deduplicateBy.map((c) => this.escapeId(c)).join(', ')}`;
+            }
+        }
+        await this.query(sql);
+    }
+    // ==================== Dictionaries ====================
+    /**
+     * `CREATE DICTIONARY <name> (attrs) PRIMARY KEY <key> SOURCE(...) LAYOUT(...)
+     * LIFETIME(...)` — ClickHouse's in-memory key/value lookup/enrichment object
+     * backed by another table, file, or HTTP/DB source. Exposed so callers get a
+     * typed builder instead of hand-writing the multi-clause DDL.
+     *
+     * @param options.attributes - dictionary columns (`name type`, optional default/expression).
+     * @param options.primaryKey - key attribute name(s).
+     * @param options.source - raw `SOURCE(...)` body, e.g. `CLICKHOUSE(TABLE 'users')`.
+     * @param options.layout - raw `LAYOUT(...)` body, e.g. `HASHED()` / `FLAT()` / `COMPLEX_KEY_HASHED()`.
+     * @param options.lifetime - refresh lifetime; a number => `LIFETIME(n)`, a
+     *   `{min,max}` => `LIFETIME(MIN min MAX max)`.
+     */
+    async createDictionary(name, options) {
+        let sql = options.replace ? 'CREATE OR REPLACE DICTIONARY' : 'CREATE DICTIONARY';
+        if (!options.replace && options.ifNotExists)
+            sql += ' IF NOT EXISTS';
+        sql += ` ${this.quoteTable(name)}`;
+        const attrs = options.attributes
+            .map((a) => {
+            let col = `${this.escapeId(a.name)} ${a.type}`;
+            if (a.default !== undefined)
+                col += ` DEFAULT ${a.default}`;
+            if (a.expression !== undefined)
+                col += ` EXPRESSION ${a.expression}`;
+            return col;
+        })
+            .join(', ');
+        sql += ` (${attrs})`;
+        const pk = Array.isArray(options.primaryKey) ? options.primaryKey : [options.primaryKey];
+        sql += ` PRIMARY KEY ${pk.map((k) => this.escapeId(k)).join(', ')}`;
+        sql += ` SOURCE(${options.source})`;
+        sql += ` LAYOUT(${options.layout})`;
+        if (options.lifetime !== undefined) {
+            if (typeof options.lifetime === 'number') {
+                sql += ` LIFETIME(${options.lifetime})`;
+            }
+            else {
+                sql += ` LIFETIME(MIN ${options.lifetime.min} MAX ${options.lifetime.max})`;
+            }
+        }
+        if (options.comment) {
+            sql += ` COMMENT '${this.escapeString(options.comment)}'`;
+        }
+        await this.query(sql);
+    }
+    async dropDictionary(name, options) {
+        let sql = 'DROP DICTIONARY';
+        if (options?.ifExists)
+            sql += ' IF EXISTS';
+        sql += ` ${this.quoteTable(name)}`;
+        await this.query(sql);
+    }
     async showTables() {
         const result = await this.query(`SELECT name FROM system.tables WHERE database = currentDatabase() AND engine NOT IN ('View', 'MaterializedView') ORDER BY name`);
         return result.rows.map((row) => row.name);