clickhouse-migrations 0.1.9 → 0.1.11

package/README.md

@@ -1,7 +1,7 @@
 
 # clickhouse-migrations
 
-> CLI NodeJS ClickHouse Migrations.
+> ClickHouse Migrations CLI
 
 ## Install
 
@@ -11,11 +11,13 @@ npm install --global clickhouse-migrations
 
 ## Usage
 
-Create a directory, where migrations will be stored. It will be used as the value for the `--migrations-home` option.
+Create a directory, where migrations will be stored. It will be used as the value for the `--migrations-home` option (or for environment variable `CH_MIGRATIONS_HOME`).
 
-In the directory, create migrations - which should be named like: `1_`some_text`.sql`, `2_`other_text`.sql`, ... `10_`more_test`.sql`. What is important here: migration versions followed by underscore - `1_`, `2_`, ...`10_`..., and file extension `.sql`. Any text can follow by version number. The version number should increase for every next migration.
+In the directory, create migration files, which should be named like this: `1_some_text.sql`, `2_other_text.sql`, `10_more_test.sql`. What's important here is that the migration version number should come first, followed by an underscore (`_`), and then any text can follow. The version number should increase for every next migration. Please note that once a migration file has been applied to the database, it cannot be modified or removed. 
 
-For migrations' content should be used correct SQL ClickHouse queries. A few queries can be used in one migration file. Every query should end with `;`. The queries could be idempotent - for example: `CREATE TABLE IF NOT EXISTS table ...;` For adding comments should be used `--`, `# `, `#!` at the beginning of the line.
+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 `--`, `# `, `#!` at the beginning of the line. 
+
+If the database provided in the `--db` option (or in `CH_MIGRATIONS_DB`) doesn't exist, it will be created automatically.
 
 ```
   Usage
@@ -37,9 +39,21 @@ For migrations' content should be used correct SQL ClickHouse queries. A few que
       CH_MIGRATIONS_DB          Database name (--db)
       CH_MIGRATIONS_HOME        Migrations' directory (--migrations-home)
 
-  Examples
+  CLI examples
       clickhouse-migrations migrate --host=http://localhost:8123 
       --user=default --password='' --db=analytics 
       --migrations-home=/app/clickhouse/migrations
 
       clickhouse-migrations migrate 
+```
+
+Migration file example:
+```
+-- an example of migration file 1_init.sql
+
+SET allow_experimental_object_type = 1;
+
+CREATE TABLE IF NOT EXISTS events (
+  event JSON
+);
+```      

package/lib/migrate.d.ts

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

package/lib/migrate.js

@@ -39,22 +39,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.migrate = void 0;
+exports.migration = exports.migrate = void 0;
 var client_1 = require("@clickhouse/client");
 var commander_1 = require("commander");
 var fs_1 = __importDefault(require("fs"));
 var crypto_1 = __importDefault(require("crypto"));
-// Extract SQL queries from migrations.
-var sql_queries = function (content) {
-    var queries = content
-        .replace(/^(--|#!|# ).*(\n|\r\n|\r)$/gm, '')
-        .replace(/(\n|\r\n|\r)/gm, ' ')
-        .replace(/\s+/g, ' ')
-        .split(';')
-        .map(function (el) { return el.trim(); })
-        .filter(function (el) { return el.length != 0; });
-    return queries;
-};
+var sql_parse_1 = require("./sql-parse");
 var log = function (type, message, error) {
     if (type === void 0) { type = 'info'; }
     if (type === 'info') {
@@ -146,6 +136,10 @@ var get_migrations = function (migrations_home) {
     var migrations = [];
     files.forEach(function (file) {
         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;
@@ -162,7 +156,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, _a, queries_1, query, e_4, e_5;
+    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;
     return __generator(this, function (_b) {
         switch (_b.label) {
             case 0:
@@ -220,7 +214,8 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                     // Skip if a migration is already applied.
                     return [3 /*break*/, 16];
                 }
-                queries = sql_queries(content);
+                queries = (0, sql_parse_1.sql_queries)(content);
+                sets = (0, sql_parse_1.sql_sets)(content);
                 _a = 0, queries_1 = queries;
                 _b.label = 7;
             case 7:
@@ -231,6 +226,7 @@ var apply_migrations = function (client, migrations, migrations_home) { return _
                 _b.trys.push([8, 10, , 11]);
                 return [4 /*yield*/, client.exec({
                         query: query,
+                        clickhouse_settings: sets,
                     })];
             case 9:
                 _b.sent();
@@ -301,9 +297,10 @@ var migration = function (migrations_home, host, username, password, db_name) {
         }
     });
 }); };
+exports.migration = migration;
 var migrate = function () {
     var program = new commander_1.Command();
-    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('0.1.9');
+    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('0.1.11');
     program
         .command('migrate')
         .description('Apply migrations.')

package/lib/sql-parse.d.ts

@@ -0,0 +1,5 @@
+declare const sql_queries: (content: string) => string[];
+declare const sql_sets: (content: string) => {
+    [key: string]: string;
+};
+export { sql_queries, sql_sets };

package/lib/sql-parse.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sql_sets = exports.sql_queries = void 0;
+// Extract sql queries from migrations.
+var sql_queries = function (content) {
+    var queries = content
+        .replace(/^(--|#!|#\s|SET\s).*(\n|\r\n|\r|$)/gm, '')
+        .replace(/(\n|\r\n|\r)/gm, ' ')
+        .replace(/\s+/g, ' ')
+        .split(';')
+        .map(function (el) { return el.trim(); })
+        .filter(function (el) { return el.length != 0; });
+    return queries;
+};
+exports.sql_queries = sql_queries;
+// Extract query settings from migrations.
+var sql_sets = function (content) {
+    var sets = {};
+    var sets_arr = content
+        .replace(/^(?!SET\s).*(\n|\r\n|\r|$)/gm, '')
+        .replace(/^(SET\s)/gm, '')
+        .replace(/(\n|\r\n|\r)/gm, ' ')
+        .replace(/\s+/g, '')
+        .split(';');
+    sets_arr.forEach(function (set_full) {
+        var set = set_full.split('=');
+        sets[set[0]] = set[1];
+    });
+    return sets;
+};
+exports.sql_sets = sql_sets;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "clickhouse-migrations",
-  "version": "0.1.9",
-  "description": "CLI NodeJS ClickHouse Migrations",
+  "version": "0.1.11",
+  "description": "ClickHouse Migrations",
   "bin": {
     "clickhouse-migrations": "lib/cli.js"
   },
@@ -20,21 +20,21 @@
   "license": "MIT",
   "repository": "VVVi/clickhouse-migrations",
   "dependencies": {
-    "@clickhouse/client": "^0.0.10",
-    "commander": "^9.4.1"
+    "@clickhouse/client": "^0.0.13",
+    "commander": "^10.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.2.3",
-    "@types/node": "^18.11.9",
-    "@typescript-eslint/parser": "^5.44.0",
-    "@typescript-eslint/eslint-plugin": "^5.44.0",
+    "@types/jest": "^29.4.1",
+    "@types/node": "^18.15.3",
+    "@typescript-eslint/parser": "^5.55.0",
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
     "eslint-plugin-prettier": "^4.2.1",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.5.0",
-    "jest": "^29.3.1",
-    "prettier": "^2.8.0",
-    "ts-jest": "^29.0.3",
-    "typescript": "^4.9.3"
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.7.0",
+    "jest": "^29.5.0",
+    "prettier": "^2.8.4",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
   },
   "files": [
     "lib/**/*"