clickhouse-migrations 1.0.4 → 1.1.0

package/README.md

@@ -19,6 +19,8 @@ For migrations' content should be used correct SQL ClickHouse queries. Multiple
 
 If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't exist, it will be created automatically.
 
+For TLS/HTTPS connections, you can provide a custom CA certificate and optional client certificate/key via the `--ca-cert`, `--cert`, and `--key` options (or the `CH_MIGRATIONS_CA_CERT`, `CH_MIGRATIONS_CERT`, and `CH_MIGRATIONS_KEY` environment variables).
+
 ```
   Usage
     $ clickhouse-migrations migrate <options>
@@ -36,6 +38,9 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
                                   (default: 'ENGINE=Atomic')
       --timeout=<value>         Client request timeout 
                                   (milliseconds, default: 30000)
+      --ca-cert=<path>          CA certificate file path
+      --cert=<path>             Client certificate file path
+      --key=<path>              Client key file path                            
 
   Environment variables
       Instead of options can be used environment variables.
@@ -48,6 +53,10 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
       CH_MIGRATIONS_DB_ENGINE   (optional) DB engine (--db-engine)
       CH_MIGRATIONS_TIMEOUT     (optional) Client request timeout 
                                   (--timeout)
+      CH_MIGRATIONS_CA_CERT     (optional) CA certificate file path
+      CH_MIGRATIONS_CERT        (optional) Client certificate file path
+      CH_MIGRATIONS_KEY         (optional) Client key file path
+
 
   CLI executions examples
     settings are passed as command-line options
@@ -66,6 +75,12 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
 
     settings provided partially through options and environment variables
       clickhouse-migrations migrate --timeout=60000
+
+    settings provided as options with TLS certificates
+      clickhouse-migrations migrate --host=https://localhost:8443
+      --user=default --password='' --db=analytics
+      --migrations-home=/app/clickhouse/migrations
+      --ca-cert=/app/certs/ca.pem --cert=/app/certs/client.crt --key=/app/certs/client.key
 ```
 
 Migration file example:

package/lib/migrate.d.ts

@@ -1,3 +1,3 @@
-declare const migration: (migrations_home: string, host: string, username: string, password: string, db_name: string, db_engine?: string, timeout?: string) => Promise<void>;
+declare const migration: (migrations_home: string, host: string, username: string, password: string, db_name: string, db_engine?: string, timeout?: string, ca_cert?: string | undefined, cert?: string | undefined, key?: string | undefined) => Promise<void>;
 declare const migrate: () => void;
 export { migrate, migration };

package/lib/migrate.js

@@ -63,7 +63,7 @@ var log = function (type, message, error) {
         console.error('\x1b[36m', "clickhouse-migrations :", '\x1b[31m', "Error: ".concat(message), error ? "\n\n ".concat(error) : '');
     }
 };
-var connect = function (url, username, password, db_name, timeout) {
+var connect = function (url, username, password, db_name, timeout, ca_cert, cert, key) {
     var db_params = {
         url: url,
         username: username,
@@ -76,6 +76,26 @@ var connect = function (url, username, password, db_name, timeout) {
     if (timeout) {
         db_params.request_timeout = Number(timeout);
     }
+    if (ca_cert) {
+        try {
+            if (cert && key) {
+                db_params.tls = {
+                    ca_cert: fs_1.default.readFileSync(ca_cert),
+                    cert: fs_1.default.readFileSync(cert),
+                    key: fs_1.default.readFileSync(key),
+                };
+            }
+            else {
+                db_params.tls = {
+                    ca_cert: fs_1.default.readFileSync(ca_cert),
+                };
+            }
+        }
+        catch (e) {
+            log('error', 'Failed to read CA certificate file for TLS connection.', e instanceof Error ? e.message : String(e));
+            process.exit(1);
+        }
+    }
     return (0, client_1.createClient)(db_params);
 };
 var create_db = function (host_1, username_1, password_1, db_name_1) {
@@ -83,33 +103,46 @@ var create_db = function (host_1, username_1, password_1, db_name_1) {
     for (var _i = 4; _i < arguments.length; _i++) {
         args_1[_i - 4] = arguments[_i];
     }
-    return __awaiter(void 0, __spreadArray([host_1, username_1, password_1, db_name_1], args_1, true), void 0, function (host, username, password, db_name, db_engine) {
-        var client, q, e_1;
+    return __awaiter(void 0, __spreadArray([host_1, username_1, password_1, db_name_1], args_1, true), void 0, function (host, username, password, db_name, db_engine, timeout, ca_cert, cert, key) {
+        var client, e_1, q, e_2;
         if (db_engine === void 0) { db_engine = 'ENGINE=Atomic'; }
         return __generator(this, function (_a) {
             switch (_a.label) {
                 case 0:
-                    client = connect(host, username, password);
-                    q = "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\" ").concat(db_engine);
+                    client = connect(host, username, password, undefined, timeout, ca_cert, cert, key);
                     _a.label = 1;
                 case 1:
                     _a.trys.push([1, 3, , 4]);
-                    return [4 /*yield*/, client.exec({
-                            query: q,
-                            clickhouse_settings: {
-                                wait_end_of_query: 1,
-                            },
-                        })];
+                    return [4 /*yield*/, client.ping()];
                 case 2:
                     _a.sent();
                     return [3 /*break*/, 4];
                 case 3:
                     e_1 = _a.sent();
-                    log('error', "can't create the database ".concat(db_name, "."), e_1.message);
+                    log('error', "Failed to connect to ClickHouse", e_1.message);
                     process.exit(1);
                     return [3 /*break*/, 4];
-                case 4: return [4 /*yield*/, client.close()];
+                case 4:
+                    q = "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\" ").concat(db_engine);
+                    _a.label = 5;
                 case 5:
+                    _a.trys.push([5, 7, , 8]);
+                    return [4 /*yield*/, client.exec({
+                            query: q,
+                            clickhouse_settings: {
+                                wait_end_of_query: 1,
+                            },
+                        })];
+                case 6:
+                    _a.sent();
+                    return [3 /*break*/, 8];
+                case 7:
+                    e_2 = _a.sent();
+                    log('error', "can't create the database ".concat(db_name, "."), e_2.message);
+                    process.exit(1);
+                    return [3 /*break*/, 8];
+                case 8: return [4 /*yield*/, client.close()];
+                case 9:
                     _a.sent();
                     return [2 /*return*/];
             }
@@ -117,7 +150,7 @@ var create_db = function (host_1, username_1, password_1, db_name_1) {
     });
 };
 var init_migration_table = function (client) { return __awaiter(void 0, void 0, void 0, function () {
-    var q, e_2;
+    var q, e_3;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
@@ -135,8 +168,8 @@ var init_migration_table = function (client) { return __awaiter(void 0, void 0,
                 _a.sent();
                 return [3 /*break*/, 4];
             case 3:
-                e_2 = _a.sent();
-                log('error', "can't create the _migrations table.", e_2.message);
+                e_3 = _a.sent();
+                log('error', "can't create the _migrations table.", e_3.message);
                 process.exit(1);
                 return [3 /*break*/, 4];
             case 4: return [2 /*return*/];
@@ -154,14 +187,15 @@ var get_migrations = function (migrations_home) {
     }
     var migrations = [];
     files.forEach(function (file) {
+        // Manage only .sql files.
+        if (!file.endsWith('.sql')) {
+            return;
+        }
         var version = Number(file.split('_')[0]);
         if (!version) {
             log('error', "a migration name should start from number, example: 1_init.sql. Please check, if the migration ".concat(file, " is named correctly"));
             process.exit(1);
         }
-        // Manage only .sql files.
-        if (!file.endsWith('.sql'))
-            return;
         migrations.push({
             version: version,
             file: file,
@@ -175,7 +209,7 @@ var get_migrations = function (migrations_home) {
     return migrations;
 };
 var apply_migrations = function (client, migrations, migrations_home) { return __awaiter(void 0, void 0, void 0, function () {
-    var migration_query_result, resultSet, e_3, migrations_applied, applied_migrations, _i, migrations_1, migration_1, content, checksum, queries, sets, _a, queries_1, query, e_4, e_5;
+    var migration_query_result, resultSet, e_4, migrations_applied, applied_migrations, _i, migrations_1, migration_1, content, checksum, queries, sets, _a, queries_1, query, e_5, e_6;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
@@ -194,8 +228,8 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 migration_query_result = _b.sent();
                 return [3 /*break*/, 5];
             case 4:
-                e_3 = _b.sent();
-                log('error', "can't select data from the _migrations table.", e_3.message);
+                e_4 = _b.sent();
+                log('error', "can't select data from the _migrations table.", e_4.message);
                 process.exit(1);
                 return [3 /*break*/, 5];
             case 5:
@@ -251,11 +285,11 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 _b.sent();
                 return [3 /*break*/, 11];
             case 10:
-                e_4 = _b.sent();
+                e_5 = _b.sent();
                 if (applied_migrations) {
                     log('info', "The migration(s) ".concat(applied_migrations, " was successfully applied!"));
                 }
-                log('error', "the migrations ".concat(migration_1.file, " has an error. Please, fix it (be sure that already executed parts of the migration would not be run second time) and re-run migration script."), e_4.message);
+                log('error', "the migrations ".concat(migration_1.file, " has an error. Please, fix it (be sure that already executed parts of the migration would not be run second time) and re-run migration script."), e_5.message);
                 process.exit(1);
                 return [3 /*break*/, 11];
             case 11:
@@ -272,8 +306,8 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 _b.sent();
                 return [3 /*break*/, 15];
             case 14:
-                e_5 = _b.sent();
-                log('error', "can't insert a data into the table _migrations.", e_5.message);
+                e_6 = _b.sent();
+                log('error', "can't insert a data into the table _migrations.", e_6.message);
                 process.exit(1);
                 return [3 /*break*/, 15];
             case 15:
@@ -293,16 +327,16 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
         }
     });
 }); };
-var migration = function (migrations_home, host, username, password, db_name, db_engine, timeout) { return __awaiter(void 0, void 0, void 0, function () {
+var migration = function (migrations_home, host, username, password, db_name, db_engine, timeout, ca_cert, cert, key) { return __awaiter(void 0, void 0, void 0, function () {
     var migrations, client;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
                 migrations = get_migrations(migrations_home);
-                return [4 /*yield*/, create_db(host, username, password, db_name, db_engine)];
+                return [4 /*yield*/, create_db(host, username, password, db_name, db_engine, timeout, ca_cert, cert, key)];
             case 1:
                 _a.sent();
-                client = connect(host, username, password, db_name, timeout);
+                client = connect(host, username, password, db_name, timeout, ca_cert, cert, key);
                 return [4 /*yield*/, init_migration_table(client)];
             case 2:
                 _a.sent();
@@ -319,7 +353,7 @@ var migration = function (migrations_home, host, username, password, db_name, db
 exports.migration = migration;
 var migrate = function () {
     var program = new commander_1.Command();
-    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('1.0.4');
+    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('1.1.0');
     program
         .command('migrate')
         .description('Apply migrations.')
@@ -330,10 +364,13 @@ var migrate = function () {
         .requiredOption('--migrations-home <dir>', "Migrations' directory", process.env.CH_MIGRATIONS_HOME)
         .option('--db-engine <value>', 'ON CLUSTER and/or ENGINE clauses for database (default: "ENGINE=Atomic")', process.env.CH_MIGRATIONS_DB_ENGINE)
         .option('--timeout <value>', 'Client request timeout (milliseconds, default value 30000)', process.env.CH_MIGRATIONS_TIMEOUT)
+        .option('--ca-cert <path>', 'CA certificate file path', process.env.CH_MIGRATIONS_CA_CERT)
+        .option('--cert <path>', 'Client certificate file path', process.env.CH_MIGRATIONS_CERT)
+        .option('--key <path>', 'Client key file path', process.env.CH_MIGRATIONS_KEY)
         .action(function (options) { return __awaiter(void 0, void 0, void 0, function () {
         return __generator(this, function (_a) {
             switch (_a.label) {
-                case 0: return [4 /*yield*/, migration(options.migrationsHome, options.host, options.user, options.password, options.db, options.dbEngine, options.timeout)];
+                case 0: return [4 /*yield*/, migration(options.migrationsHome, options.host, options.user, options.password, options.db, options.dbEngine, options.timeout, options.caCert, options.cert, options.key)];
                 case 1:
                     _a.sent();
                     return [2 /*return*/];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clickhouse-migrations",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "ClickHouse Migrations",
   "bin": {
     "clickhouse-migrations": "lib/cli.js"
@@ -17,6 +17,8 @@
   "scripts": {
     "build": "rm lib/*; tsc",
     "test": "jest --config jestconfig.json",
+    "test:unit": "jest --config jestconfig.json --testPathPatterns=\"\\.(unit|integration)\\.test\\.ts$\"",
+    "test:e2e": "jest --config jestconfig.json --testPathPatterns=\"\\.e2e\\.test\\.ts$\"",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "eslint ./src",
     "prepare": "npm run build",
@@ -26,23 +28,23 @@
     "postversion": "git push && git push --tags"
   },
   "dependencies": {
-    "@clickhouse/client": "^1.10.1",
-    "commander": "^13.1.0"
+    "@clickhouse/client": "^1.12.0",
+    "commander": "^14.0.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.18.0",
-    "@types/jest": "^29.5.14",
-    "@types/node": "^22.10.7",
-    "@typescript-eslint/eslint-plugin": "^8.21.0",
-    "@typescript-eslint/parser": "^8.21.0",
-    "eslint": "^9.18.0",
-    "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-prettier": "^5.2.3",
-    "jest": "^29.7.0",
-    "prettier": "^3.4.2",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.7.3",
-    "typescript-eslint": "^8.21.0"
+    "@eslint/js": "^9.33.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.2.1",
+    "@typescript-eslint/eslint-plugin": "^8.39.0",
+    "@typescript-eslint/parser": "^8.39.0",
+    "eslint": "^9.33.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jest": "^30.0.5",
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.1",
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.39.0"
   },
   "files": [
     "lib/**/*"