clickhouse-migrations 0.2.2 → 1.0.1

package/README.md

@@ -32,7 +32,10 @@ If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't
       --migrations-home=<dir>   Migrations' directory
 
   Optional options
-      --timeout=<value>         Client request timeout (milliseconds, default value 30000)
+      --db-engine=<value>       ON CLUSTER and/or ENGINE for DB
+                                  (default: 'ENGINE=Atomic')
+      --timeout=<value>         Client request timeout 
+                                  (milliseconds, default: 30000)
 
   Environment variables
       Instead of options can be used environment variables.
@@ -41,25 +44,45 @@ 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 
+      CH_MIGRATIONS_DB_ENGINE   (optional) DB engine (--db-engine)
+      CH_MIGRATIONS_TIMEOUT     (optional) Client request timeout 
+                                  (--timeout)
+
+  CLI executions examples
+    settings are passed as command-line options
+      clickhouse-migrations migrate --host=http://localhost:8123
       --user=default --password='' --db=analytics 
       --migrations-home=/app/clickhouse/migrations
 
+    settings provided as options, including timeout and db-engine
+      clickhouse-migrations migrate --host=http://localhost:8123 
+      --user=default --password='' --db=analytics 
+      --migrations-home=/app/clickhouse/migrations --timeout=60000 
+      --db-engine="ON CLUSTER default ENGINE=Replicated('{replica}')"    
+
+    settings provided as environment variables
       clickhouse-migrations migrate
 
+    settings provided partially through options and environment variables
       clickhouse-migrations migrate --timeout=60000
 ```
 
 Migration file example:
+(e.g., located at /app/clickhouse/migrations/1_init.sql)
 ```
 -- an example of migration file 1_init.sql
 
 SET allow_experimental_object_type = 1;
 
 CREATE TABLE IF NOT EXISTS events (
+  timestamp DateTime('UTC'),
+  session_id UInt64,
   event JSON
-);
+)
+ENGINE=AggregatingMergeTree
+PARTITION BY toYYYYMM(timestamp) 
+SAMPLE BY session_id 
+ORDER BY (session_id) 
+SETTINGS index_granularity = 8192;
 ```      

package/lib/migrate.d.ts

@@ -1,3 +1,3 @@
-declare const migration: (migrations_home: string, host: string, username: string, password: string, db_name: 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) => Promise<void>;
 declare const migrate: () => void;
 export { migrate, migration };

package/lib/migrate.js

@@ -35,6 +35,15 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -69,37 +78,44 @@ var connect = function (url, username, password, db_name, 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 () {
-    var client, q, e_1;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0:
-                client = connect(host, username, password);
-                q = "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\" ENGINE = Atomic");
-                _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,
-                        },
-                    })];
-            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);
-                process.exit(1);
-                return [3 /*break*/, 4];
-            case 4: return [4 /*yield*/, client.close()];
-            case 5:
-                _a.sent();
-                return [2 /*return*/];
-        }
+var create_db = function (host_1, username_1, password_1, db_name_1) {
+    var args_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;
+        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);
+                    _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,
+                            },
+                        })];
+                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);
+                    process.exit(1);
+                    return [3 /*break*/, 4];
+                case 4: return [4 /*yield*/, client.close()];
+                case 5:
+                    _a.sent();
+                    return [2 /*return*/];
+            }
+        });
     });
-}); };
+};
 var init_migration_table = function (client) { return __awaiter(void 0, void 0, void 0, function () {
     var q, e_2;
     return __generator(this, function (_a) {
@@ -277,13 +293,13 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
         }
     });
 }); };
-var migration = function (migrations_home, host, username, password, db_name, timeout) { return __awaiter(void 0, void 0, void 0, function () {
+var migration = function (migrations_home, host, username, password, db_name, db_engine, timeout) { 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)];
+                return [4 /*yield*/, create_db(host, username, password, db_name, db_engine)];
             case 1:
                 _a.sent();
                 client = connect(host, username, password, db_name, timeout);
@@ -303,7 +319,7 @@ var migration = function (migrations_home, host, username, password, db_name, ti
 exports.migration = migration;
 var migrate = function () {
     var program = new commander_1.Command();
-    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('0.1.13');
+    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('1.0.1');
     program
         .command('migrate')
         .description('Apply migrations.')
@@ -312,11 +328,12 @@ 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('--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)
         .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.timeout)];
+                case 0: return [4 /*yield*/, migration(options.migrationsHome, options.host, options.user, options.password, options.db, options.dbEngine, options.timeout)];
                 case 1:
                     _a.sent();
                     return [2 /*return*/];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clickhouse-migrations",
-  "version": "0.2.2",
+  "version": "1.0.1",
   "description": "ClickHouse Migrations",
   "bin": {
     "clickhouse-migrations": "lib/cli.js"