ruby: update 'README.md'

kwatch · Nov 27, 2013 · 3dd200e · 3dd200e
1 parent ed5f922
commit 3dd200e
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -169,6 +169,15 @@ Tips
   script in `migr8/migrations/abcd1234.yaml` file.)
   This may help you when switching Git/Hg branch.
 
+* `migr8.rb` generates sql file and run it with sql command such as `psql`
+  (PostgreSQL), `sqlite3` (SQLite3) or `mysql` (MySQL). Therefore you can
+  use non-sql command in migration file.
+  For example:
+
+        up: |
+          -- read data from CSV file and insert into DB (PostgreSQL)
+          \copy table1 from 'file1.csv' with csv;
+
 * **MySQL doesn't support transactional DDL**.
   It will cause troubles when you have errors in migration script
   (See https://www.google.com/search?q=transactional+DDL for details).

diff --git a/lib/migr8.rb b/lib/migr8.rb
@@ -2490,6 +2490,15 @@ def escape(value)
   script in `migr8/migrations/abcd1234.yaml` file.)
   This may help you when switching Git/Hg branch.
 
+* `migr8.rb` generates sql file and run it with sql command such as `psql`
+  (PostgreSQL), `sqlite3` (SQLite3) or `mysql` (MySQL). Therefore you can
+  use non-sql command in migration file.
+  For example:
+
+    up: |
+      -- read data from CSV file and insert into DB (PostgreSQL)
+      \copy table1 from 'file1.csv' with csv;
+
 * **MySQL doesn't support transactional DDL**.
   It will cause troubles when you have errors in migration script
   (See https://www.google.com/search?q=transactional+DDL for details).