clickhouse-migrations 0.1.13 → 0.2.2

package/README.md

@@ -31,6 +31,9 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
       --db=<name>               Database name
       --migrations-home=<dir>   Migrations' directory
 
+  Optional options
+      --timeout=<value>         Client request timeout (milliseconds, default value 30000)
+
   Environment variables
       Instead of options can be used environment variables.
       CH_MIGRATIONS_HOST        Clickhouse hostname (--host)
@@ -38,13 +41,16 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
       CH_MIGRATIONS_PASSWORD    Password (--password)
       CH_MIGRATIONS_DB          Database name (--db)
       CH_MIGRATIONS_HOME        Migrations' directory (--migrations-home)
+      CH_MIGRATIONS_TIMEOUT     Client request timeout (--timeout)
 
   CLI examples
       clickhouse-migrations migrate --host=http://localhost:8123 
       --user=default --password='' --db=analytics 
       --migrations-home=/app/clickhouse/migrations
 
-      clickhouse-migrations migrate 
+      clickhouse-migrations migrate
+
+      clickhouse-migrations migrate --timeout=60000
 ```
 
 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) => Promise<void>;
+declare const migration: (migrations_home: string, host: string, username: string, password: string, db_name: string, timeout?: string) => Promise<void>;
 declare const migrate: () => void;
 export { migrate, migration };

package/lib/migrate.js

@@ -54,9 +54,9 @@ 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 (host, username, password, db_name) {
+var connect = function (url, username, password, db_name, timeout) {
     var db_params = {
-        host: host,
+        url: url,
         username: username,
         password: password,
         application: 'clickhouse-migrations',
@@ -64,6 +64,9 @@ var connect = function (host, username, password, db_name) {
     if (db_name) {
         db_params.database = db_name;
     }
+    if (timeout) {
+        db_params.request_timeout = Number(timeout);
+    }
     return (0, client_1.createClient)(db_params);
 };
 var create_db = function (host, username, password, db_name) { return __awaiter(void 0, void 0, void 0, function () {
@@ -72,7 +75,7 @@ var create_db = function (host, username, password, db_name) { return __awaiter(
         switch (_a.label) {
             case 0:
                 client = connect(host, username, password);
-                q = "CREATE DATABASE IF NOT EXISTS ".concat(db_name, " ENGINE = Atomic");
+                q = "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\" ENGINE = Atomic");
                 _a.label = 1;
             case 1:
                 _a.trys.push([1, 3, , 4]);
@@ -102,7 +105,7 @@ var init_migration_table = function (client) { return __awaiter(void 0, void 0,
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
-                q = "CREATE TABLE IF NOT EXISTS _migrations (\n      uid UUID DEFAULT generateUUIDv4(), \n      version UInt32,\n      checksum String, \n      migration_name String, \n      applied_at DateTime DEFAULT now()\n    ) \n    ENGINE = MergeTree \n    ORDER BY tuple(applied_at)";
+                q = "CREATE TABLE IF NOT EXISTS _migrations (\n      uid UUID DEFAULT generateUUIDv4(),\n      version UInt32,\n      checksum String,\n      migration_name String,\n      applied_at DateTime DEFAULT now()\n    )\n    ENGINE = MergeTree\n    ORDER BY tuple(applied_at)";
                 _a.label = 1;
             case 1:
                 _a.trys.push([1, 3, , 4]);
@@ -274,7 +277,7 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
         }
     });
 }); };
-var migration = function (migrations_home, host, username, password, db_name) { return __awaiter(void 0, void 0, void 0, function () {
+var migration = function (migrations_home, host, username, password, db_name, timeout) { return __awaiter(void 0, void 0, void 0, function () {
     var migrations, client;
     return __generator(this, function (_a) {
         switch (_a.label) {
@@ -283,7 +286,7 @@ var migration = function (migrations_home, host, username, password, db_name) {
                 return [4 /*yield*/, create_db(host, username, password, db_name)];
             case 1:
                 _a.sent();
-                client = connect(host, username, password, db_name);
+                client = connect(host, username, password, db_name, timeout);
                 return [4 /*yield*/, init_migration_table(client)];
             case 2:
                 _a.sent();
@@ -309,10 +312,11 @@ var migrate = function () {
         .requiredOption('--password <password>', 'Password', process.env.CH_MIGRATIONS_PASSWORD)
         .requiredOption('--db <name>', 'Database name', process.env.CH_MIGRATIONS_DB)
         .requiredOption('--migrations-home <dir>', "Migrations' directory", process.env.CH_MIGRATIONS_HOME)
+        .option('--timeout <value>', 'Client request timeout (milliseconds, default value 30000)', process.env.CH_MIGRATIONS_TIMEOUT)
         .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)];
+                case 0: return [4 /*yield*/, migration(options.migrationsHome, options.host, options.user, options.password, options.db, options.timeout)];
                 case 1:
                     _a.sent();
                     return [2 /*return*/];

package/package.json

@@ -1,10 +1,19 @@
 {
   "name": "clickhouse-migrations",
-  "version": "0.1.13",
+  "version": "0.2.2",
   "description": "ClickHouse Migrations",
   "bin": {
     "clickhouse-migrations": "lib/cli.js"
   },
+  "main": "lib/migrate.js",
+  "types": "lib/migrate.d.ts",
+  "engines": {
+    "node": ">=16"
+  },
+  "private": false,
+  "license": "MIT",
+  "author": "VVVi",
+  "repository": "VVVi/clickhouse-migrations",
   "scripts": {
     "build": "rm lib/*; tsc",
     "test": "jest --config jestconfig.json",
@@ -16,25 +25,22 @@
     "version": "npm run format && git add -A src",
     "postversion": "git push && git push --tags"
   },
-  "author": "",
-  "license": "MIT",
-  "repository": "VVVi/clickhouse-migrations",
   "dependencies": {
-    "@clickhouse/client": "^0.0.14",
-    "commander": "^10.0.0"
+    "@clickhouse/client": "^1.5.0",
+    "commander": "^12.1.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.0",
-    "@types/node": "^18.15.11",
-    "@typescript-eslint/parser": "^5.57.0",
-    "@typescript-eslint/eslint-plugin": "^5.57.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint": "^8.37.0",
-    "eslint-config-prettier": "^8.8.0",
-    "jest": "^29.5.0",
-    "prettier": "^2.8.7",
-    "ts-jest": "^29.0.5",
-    "typescript": "^4.9.5"
+    "@types/jest": "^29.5.12",
+    "@types/node": "^22.5.4",
+    "@typescript-eslint/eslint-plugin": "^8.4.0",
+    "@typescript-eslint/parser": "^8.4.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.5.4"
   },
   "files": [
     "lib/**/*"