clickhouse-migrations 0.1.10 → 0.1.11

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 `--`, `# `, `#!` 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
@@ -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.11');
     program
         .command('migrate')
         .description('Apply migrations.')

package/package.json

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