clickhouse-migrations 1.2.0 → 1.3.0

package/README.md

@@ -16,7 +16,7 @@ In the directory, create migration files, which should be named like this: `1_so
 
 For migrations' content should be used correct SQL ClickHouse queries. Multiple queries can be used in a single migration file, and each query should be terminated with a semicolon (;). The queries could be idempotent - for example: `CREATE TABLE IF NOT EXISTS table ...;` Clickhouse settings, that can be included at the query level, can be added like `SET allow_experimental_object_type = 1;`. For adding comments should be used `--`, `# `, `#!`.
 
-If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't exist, it will be created automatically.
+If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't exist, it will be created automatically. To disable this behavior (for example, when the user has no privileges to create databases), use the `--skip-db-creation` option (or set `CH_MIGRATIONS_SKIP_DB_CREATION` to `'true'`); in that case the database must already exist.
 
 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).
 
@@ -42,6 +42,7 @@ For TLS/HTTPS connections, you can provide a custom CA certificate and optional
       --ca-cert=<path>          CA certificate file path
       --cert=<path>             Client certificate file path
       --key=<path>              Client key file path
+      --skip-db-creation        Skip database creation
 
   Environment variables
       Instead of options can be used environment variables.
@@ -58,6 +59,10 @@ For TLS/HTTPS connections, you can provide a custom CA certificate and optional
       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
+      CH_MIGRATIONS_SKIP_DB_CREATION
+                                (optional) Skip database creation,
+                                  set to 'true' to enable
+                                  (--skip-db-creation)
 
 
   CLI executions examples
@@ -84,6 +89,11 @@ For TLS/HTTPS connections, you can provide a custom CA certificate and optional
       --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
+
+    skip database creation (assumes database already exists)
+      clickhouse-migrations migrate --host=http://localhost:8123
+      --user=default --password='' --db=analytics
+      --migrations-home=/app/clickhouse/migrations --skip-db-creation
 ```
 
 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, table_engine?: string, timeout?: string, ca_cert?: string | undefined, cert?: string | undefined, key?: string | undefined) => Promise<void>;
+declare const migration: (migrations_home: string, host: string, username: string, password: string, db_name: string, db_engine?: string, table_engine?: string, timeout?: string, ca_cert?: string | undefined, cert?: string | undefined, key?: string | undefined, skip_db_creation?: boolean) => Promise<void>;
 declare const migrate: () => void;
 export { migrate, migration };

package/lib/migrate.js

@@ -99,8 +99,8 @@ var connect = function (url, username, password, db_name, timeout, ca_cert, cert
     }
     return (0, client_1.createClient)(db_params);
 };
-var create_db = function (host, username, password, db_name, db_engine, timeout, ca_cert, cert, key) { return __awaiter(void 0, void 0, void 0, function () {
-    var client, e_1, q, e_2;
+var create_db = function (host, username, password, db_name, db_engine, timeout, ca_cert, cert, key, skip_db_creation) { return __awaiter(void 0, void 0, void 0, function () {
+    var client, e_1, exists, resultSet, rows, e_2, q, e_3;
     return __generator(this, function (_a) {
         switch (_a.label) {
             case 0:
@@ -118,28 +118,66 @@ var create_db = function (host, username, password, db_name, db_engine, timeout,
                 process.exit(1);
                 return [3 /*break*/, 4];
             case 4:
+                if (!skip_db_creation) return [3 /*break*/, 14];
+                exists = false;
+                _a.label = 5;
+            case 5:
+                _a.trys.push([5, 8, , 10]);
+                return [4 /*yield*/, client.query({
+                        query: "SELECT 1 AS ok FROM system.databases WHERE name = {db_name:String}",
+                        query_params: { db_name: db_name },
+                        format: 'JSONEachRow',
+                    })];
+            case 6:
+                resultSet = _a.sent();
+                return [4 /*yield*/, resultSet.json()];
+            case 7:
+                rows = (_a.sent());
+                exists = rows.length > 0;
+                return [3 /*break*/, 10];
+            case 8:
+                e_2 = _a.sent();
+                log('error', "can't verify that the database ".concat(db_name, " exists."), e_2.message);
+                return [4 /*yield*/, client.close()];
+            case 9:
+                _a.sent();
+                process.exit(1);
+                return [3 /*break*/, 10];
+            case 10:
+                if (!!exists) return [3 /*break*/, 12];
+                log('error', "the database ".concat(db_name, " doesn't exist and --skip-db-creation is set. Please create the database manually or remove --skip-db-creation."));
+                return [4 /*yield*/, client.close()];
+            case 11:
+                _a.sent();
+                process.exit(1);
+                _a.label = 12;
+            case 12: return [4 /*yield*/, client.close()];
+            case 13:
+                _a.sent();
+                return [2 /*return*/];
+            case 14:
                 q = db_engine
                     ? "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\" ").concat(db_engine)
                     : "CREATE DATABASE IF NOT EXISTS \"".concat(db_name, "\"");
-                _a.label = 5;
-            case 5:
-                _a.trys.push([5, 7, , 8]);
+                _a.label = 15;
+            case 15:
+                _a.trys.push([15, 17, , 18]);
                 return [4 /*yield*/, client.command({
                         query: q,
                         clickhouse_settings: {
                             wait_end_of_query: 1,
                         },
                     })];
-            case 6:
+            case 16:
                 _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);
+                return [3 /*break*/, 18];
+            case 17:
+                e_3 = _a.sent();
+                log('error', "can't create the database ".concat(db_name, "."), e_3.message);
                 process.exit(1);
-                return [3 /*break*/, 8];
-            case 8: return [4 /*yield*/, client.close()];
-            case 9:
+                return [3 /*break*/, 18];
+            case 18: return [4 /*yield*/, client.close()];
+            case 19:
                 _a.sent();
                 return [2 /*return*/];
         }
@@ -151,7 +189,7 @@ var init_migration_table = function (client_2) {
         args_1[_i - 1] = arguments[_i];
     }
     return __awaiter(void 0, __spreadArray([client_2], args_1, true), void 0, function (client, table_engine) {
-        var q, e_3;
+        var q, e_4;
         if (table_engine === void 0) { table_engine = 'MergeTree'; }
         return __generator(this, function (_a) {
             switch (_a.label) {
@@ -170,8 +208,8 @@ var init_migration_table = function (client_2) {
                     _a.sent();
                     return [3 /*break*/, 4];
                 case 3:
-                    e_3 = _a.sent();
-                    log('error', "can't create the _migrations table.", e_3.message);
+                    e_4 = _a.sent();
+                    log('error', "can't create the _migrations table.", e_4.message);
                     process.exit(1);
                     return [3 /*break*/, 4];
                 case 4: return [2 /*return*/];
@@ -212,7 +250,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_4, migrations_applied, applied_migrations, _i, migrations_1, migration_1, content, checksum, queries, sets, _a, queries_1, query, e_5, e_6;
+    var migration_query_result, resultSet, e_5, migrations_applied, applied_migrations, _i, migrations_1, migration_1, content, checksum, queries, sets, _a, queries_1, query, e_6, e_7;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
@@ -231,8 +269,8 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 migration_query_result = _b.sent();
                 return [3 /*break*/, 5];
             case 4:
-                e_4 = _b.sent();
-                log('error', "can't select data from the _migrations table.", e_4.message);
+                e_5 = _b.sent();
+                log('error', "can't select data from the _migrations table.", e_5.message);
                 process.exit(1);
                 return [3 /*break*/, 5];
             case 5:
@@ -288,11 +326,11 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 _b.sent();
                 return [3 /*break*/, 11];
             case 10:
-                e_5 = _b.sent();
+                e_6 = _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_5.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_6.message);
                 process.exit(1);
                 return [3 /*break*/, 11];
             case 11:
@@ -309,8 +347,8 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 _b.sent();
                 return [3 /*break*/, 15];
             case 14:
-                e_6 = _b.sent();
-                log('error', "can't insert a data into the table _migrations.", e_6.message);
+                e_7 = _b.sent();
+                log('error', "can't insert a data into the table _migrations.", e_7.message);
                 process.exit(1);
                 return [3 /*break*/, 15];
             case 15:
@@ -330,13 +368,13 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
         }
     });
 }); };
-var migration = function (migrations_home, host, username, password, db_name, db_engine, table_engine, timeout, ca_cert, cert, key) { return __awaiter(void 0, void 0, void 0, function () {
+var migration = function (migrations_home, host, username, password, db_name, db_engine, table_engine, timeout, ca_cert, cert, key, skip_db_creation) { 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, timeout, ca_cert, cert, key)];
+                return [4 /*yield*/, create_db(host, username, password, db_name, db_engine, timeout, ca_cert, cert, key, skip_db_creation)];
             case 1:
                 _a.sent();
                 client = connect(host, username, password, db_name, timeout, ca_cert, cert, key);
@@ -371,10 +409,11 @@ var migrate = function () {
         .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)
+        .option('--skip-db-creation', 'Skip database creation', process.env.CH_MIGRATIONS_SKIP_DB_CREATION === 'true')
         .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.tableEngine, options.timeout, options.caCert, options.cert, options.key)];
+                case 0: return [4 /*yield*/, migration(options.migrationsHome, options.host, options.user, options.password, options.db, options.dbEngine, options.tableEngine, options.timeout, options.caCert, options.cert, options.key, options.skipDbCreation)];
                 case 1:
                     _a.sent();
                     return [2 /*return*/];

package/lib/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.2.0";
+export declare const VERSION = "1.3.0";

package/lib/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.2.0'; // x-release-please-version
+exports.VERSION = '1.3.0'; // x-release-please-version

package/package.json

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