clickhouse-migrations 0.1.10 → 0.1.12

package/README.md

@@ -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 files - 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. Can be used ClickHouse settings - that can be applied on query level, in the format: `SET allow_experimental_object_type = 1;` A migration file can't be changed or removed after applying.
+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.
 
 ```
   Usage
@@ -43,13 +45,15 @@ For migrations' content should be used correct SQL ClickHouse queries. A few que
       --migrations-home=/app/clickhouse/migrations
 
       clickhouse-migrations migrate 
-  
-  Migration file example (could be named 'init-1.sql' and stored in the
-  directory provided in --migrations-home)
+```
+
+Migration file example:
+```
+-- an example of migration file 1_init.sql
 
-      SET allow_experimental_object_type = 1;
+SET allow_experimental_object_type = 1;
 
-      CREATE TABLE IF NOT EXISTS events (
-        event JSON
-      );
+CREATE TABLE IF NOT EXISTS events (
+  event JSON
+);
 ```      

package/lib/migrate.js

@@ -300,7 +300,7 @@ 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.10');
+    program.name('clickhouse-migrations').description('ClickHouse migrations.').version('0.1.12');
     program
         .command('migrate')
         .description('Apply migrations.')

package/lib/sql-parse.js

@@ -4,7 +4,8 @@ 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(/(--|#!|#\s).*(\n|\r\n|\r|$)/gm, '\n')
+        .replace(/^\s*(SET\s).*(\n|\r\n|\r|$)/gm, '')
         .replace(/(\n|\r\n|\r)/gm, ' ')
         .replace(/\s+/g, ' ')
         .split(';')
@@ -17,15 +18,31 @@ exports.sql_queries = sql_queries;
 var sql_sets = function (content) {
     var sets = {};
     var sets_arr = content
-        .replace(/^(?!SET\s).*(\n|\r\n|\r|$)/gm, '')
-        .replace(/^(SET\s)/gm, '')
+        .replace(/(--|#!|#\s).*(\n|\r\n|\r|$)/gm, '\n')
+        .replace(/^\s*(?!SET\s).*(\n|\r\n|\r|$)/gm, '')
+        .replace(/^\s*(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];
+        if (set[0]) {
+            sets[set[0]] = set[1];
+        }
     });
     return sets;
 };
 exports.sql_sets = sql_sets;
+// -- any
+// SET allow_experimental_object_type = 1; --set option
+// SET allow_experimental_object_new = 1;
+// SELECT * FROM events
+// sdfsfdsd
+// -- asssss
+//  --asdf
+// sdfsdf
+//   sdfsfs
+// SET a=1
+//   asdf
+//   SET f=22
+//   sdf

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clickhouse-migrations",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "ClickHouse Migrations",
   "bin": {
     "clickhouse-migrations": "lib/cli.js"
@@ -20,19 +20,19 @@
   "license": "MIT",
   "repository": "VVVi/clickhouse-migrations",
   "dependencies": {
-    "@clickhouse/client": "^0.0.13",
+    "@clickhouse/client": "^0.0.14",
     "commander": "^10.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.4.1",
-    "@types/node": "^18.15.3",
-    "@typescript-eslint/parser": "^5.55.0",
-    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@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.36.0",
-    "eslint-config-prettier": "^8.7.0",
+    "eslint": "^8.37.0",
+    "eslint-config-prettier": "^8.8.0",
     "jest": "^29.5.0",
-    "prettier": "^2.8.4",
+    "prettier": "^2.8.7",
     "ts-jest": "^29.0.5",
     "typescript": "^4.9.5"
   },