README.md in sql_migrations-1.0.0 vs README.md in sql_migrations-1.1.0
- old
+ new
@@ -1,182 +1,185 @@
# sql-migrations
-Simple standalone migrations gem you can use with plain SQL.
+[](http://badge.fury.io/rb/sql_migrations)
+[](https://travis-ci.org/grzesiek/sql-migrations)
-You can execute migrations, seed datebase on production and on test environment with fixtures in non-Ruby pojects.
-`sql-migrations` can work with multiple different databases.
+Simple standalone migrations you can use with plain SQL.
+This gives you possibility to execute migrations, seed datebase (on production and in test environment with fixtures) in non-Ruby pojects.
+`sql-migrations` can work with multiple different databases, and support many db adapters.
+
## Why ?
-This is particularly useful in old projects that doesn't have migrations support, and you really want to use Continues Delivery strategy.
+This is particularly useful in old projects that don't have migration support, and you really want to use Continues Delivery strategy.
Without migrations you wouldn't be able to setup your test environment for automated testing (functional tests, unit tests, integration tests).
-For example, if you work in old Zend1 project, and you want to take benefit from using Continues Deployment/Continues Integration mechanisms - you may find this project useful.
+For example, if you work on old Zend 1 project, and you want to take benefit from using Continues Deployment/Continues Integration mechanisms - you may find this project useful.
## Install
-`sql-migrations` are created using Ruby.
+`sql-migrations` are created using Ruby, but you can use this software with non-Ruby projects, like PHP or Java. This is standalone mechanism.
-1. First - install Ruby environment, with `rbenv` or `rvm`.
-2. If your project is not created using Ruby, create your Gemfile:
+1. First - install Ruby environment, with `rbenv` or `rvm`.
+2. If your project is not using ruby, create your Gemfile:
- ```ruby
- source 'https://rubygems.org'
- gem 'mysql2'
- gem 'sql_migrations'
- ```
+ source 'https://rubygems.org'
+ gem 'mysql2'
+ gem 'sql_migrations'
- You can use all database adapters, that are supported by `Sequel`.
- Adapters supported by `Sequel`, by now, are:
+ It is possible to use all database adapters that are supported by `Sequel`.
+ Adapters supported by `Sequel`, by now, are:
- ADO, Amalgalite, CUBRID, DataObjects, DB2, DBI, Firebird,
- FoundationDB SQL Layer, IBM_DB, Informix, JDBC, MySQL, Mysql2,
- ODBC, OpenBase, Oracle, PostgreSQL, SQLAnywhere, SQLite3,
- Swift, and TinyTDS
+ > ADO, Amalgalite, CUBRID, DataObjects, DB2, DBI, Firebird,
+ > FoundationDB SQL Layer, IBM_DB, Informix, JDBC, MySQL, Mysql2,
+ > ODBC, OpenBase, Oracle, PostgreSQL, SQLAnywhere, SQLite3,
+ > Swift, and TinyTDS
- If you are using PostgreSQL use
+ If you are using PostgreSQL use
- ```ruby
- gem 'pg'
- ```
+ gem 'pg'
-3. Run `bundle install`
+3. Run `bundle install`
-4. Create database config file, for example in `config/databases.yml`
+4. Create database config file in `db/config/databases.yml`
- ```yaml
- default:
- development:
- adapter: mysql2
- encoding: utf8
- database: test_db_dev
- username: test_user
- password: test_pass
- host: 192.168.1.1
- test:
- adapter: mysql2
- encoding: utf8
- database: test_db_test
- username: test_user
- password: test_pass
- host: 192.168.1.1
-
- production:
- adapter: mysql2
- encoding: utf8
- database: test_db_prod
- username: test_user
- password: test_pass
- host: 192.168.1.100
- second_db:
- development:
- adapter: mysql2
- encoding: utf8
- database: second_db_dev
- username: test_user
- password: test_pass
- host: 127.0.0.1
- test:
- adapter: mysql2
- encoding: utf8
- database: second_db_test
- username: test_user
- password: test_pass
- host: 127.0.0.1
- ```
+ default:
+ development:
+ adapter: mysql2
+ encoding: utf8
+ database: test_db_dev
+ username: test_user
+ password: test_pass
+ host: 192.168.1.1
+ test:
+ adapter: mysql2
+ encoding: utf8
+ database: test_db_test
+ username: test_user
+ password: test_pass
+ host: 192.168.1.1
+
+ production:
+ adapter: mysql2
+ encoding: utf8
+ database: test_db_prod
+ username: test_user
+ password: test_pass
+ host: 192.168.1.100
+ second_db:
+ development:
+ adapter: mysql2
+ encoding: utf8
+ database: second_db_dev
+ username: test_user
+ password: test_pass
+ host: 127.0.0.1
+ test:
+ adapter: mysql2
+ encoding: utf8
+ database: second_db_test
+ username: test_user
+ password: test_pass
+ host: 127.0.0.1
- Note that you need to define `default` database set.
+ Note that you need to define `default` databases set.
-4. Migrations/seed/fixtures are executed using rake tasks. So you will need to create `Rakefile`. Example `Rakefile`:
+4. Migrations/seed/fixtures are executed using rake tasks. So you will need to create `Rakefile`:
- ```ruby
- require 'bundler'
- Bundler.require
+ require 'bundler'
+ Bundler.require
- SqlMigrations.load!('db/config/databases.yml')
- SqlMigrations.load_tasks
- ```
+ SqlMigrations.load!('db/config/databases.yml')
+ SqlMigrations.load_tasks
-5. It's ready !
+5. It's ready !
## Usage
-1. Valid migration/seed/fixture file names match agains regexp `/(\d{8})_(\d{6})_(.*)?\.sql/`. So valid filenames would be:
+1. Valid migration/seed/fixture file names match agains regexp `/(\d{8})_(\d{6})_(.*)?\.sql/`. So valid filenames would be:
- ```
- 20150303_180100_test_migration.sql
- 20150303_180100_whatever_description_of_seed.sql
- 20150303_180100_fixture1.sql
- ```
+ 20150303_180100_test_migration.sql
+ 20150303_180100_whatever_description_of_seed.sql
+ 20150303_180100_fixture1.sql
- You can put plain SQL into that files.
+ You can put plain SQL into that files.
-2. You can create migrations files, seed files and fixtures in directories like this:
+2. It is possible to create migration files, seed files and fixtures inside followig directory structure:
- ```
- db/
- migrations/
- fixtures/
- seed/
- ```
+ db/
+ migrations/
+ 20150303_180100_test_migration.sql
+ fixtures/
+ 20150303_180100_fixture1.sql
+ seed/
+ 20150303_180100_whatever_description_of_seed.sql
- If you want to use multiple databases, create database directories:
+ If you want to use multiple databases, create also database directories:
- db/
- migrations/
- default/
- second_db/
- fixtures/
- default/
- second_db/
- seed/
- default/
- second_db/
+ db/
+ migrations/
+ default/
+ second_db/
+ fixtures/
+ default/
+ second_db/
+ seed/
+ default/
+ second_db/
- `default/` directory is mandatory, you can put migrations/seed data/fixtures for default database in base directories:
+ `default/` directory is optional, you can put migrations/seed data/fixtures for default database in base directories:
- db/
- migrations/
- 20150303_180100_test_migration.sql
- second_db/
- 20150303_180101_test_migration_for_second_db.sql
+ db/
+ migrations/
+ 20150303_180100_test_migration.sql
+ second_db/
+ 20150303_180101_test_migration_for_second_db.sql
-3. In every database that is specified in YAML config, `sql-migrations` will create table `sqlmigrations_schema`
-4. If everything is set up properly, you should see `sqlmigrations` tasks after typing
+3. `sql-migrations` will create table `sqlmigrations_schema` for each database specified in YAML config.
+4. If everything is set up properly, you should see new rake tasks:
rake -T
-5. Run tasks:
+ This should give output
+ rake sqlmigrations:db:migrate # Run migrations
+ rake sqlmigrations:db:seed # Seed database
+ rake sqlmigrations:db:test:seed # Seed test database with fixtures
+ rake sqlmigrations:files:list # List found migration and seed files
- rake sqlmigrations:db:migrate # this will execute migrations
- rake sqlmigrations:db:seed # this will seed database with initial data
- rake sqlmigration:files:list # this will list all migrations/seed files/fixtures that where found
-6. Enviroment variables
+5. Then, run tasks:
- If you want to run migration on different database (for example test) specify ENV:
- ```bash
- ENV=test rake sqlmigrations:db:migrate
- ENV=test rake sqlmigrations:db:test:seed
- ```
+ # this will execute migrations
+ rake sqlmigrations:db:migrate
- or in production:
+ # this will seed database with initial data
+ rake sqlmigrations:db:seed
- ```bash
- ENV=production rake sqlmigrations:db:migrate
- ENV=production rake sqlmigrations:db:seed
- ```
+ # this will list all migrations/seed files/fixtures that where found
+ rake sqlmigration:files:list
+6. Enviroment variables
+
+ If you want to run migration on different database (for example test) specify ENV:
+
+ ENV=test rake sqlmigrations:db:migrate
+ ENV=test rake sqlmigrations:db:test:seed
+
+ or in production:
+
+ ENV=production rake sqlmigrations:db:migrate
+ ENV=production rake sqlmigrations:db:seed
+
## TODO
-1. Tests
-2. Generator for `databases.yml`
-3. Generator for migrations
+1. Tests
+2. Generator for `databases.yml`
+3. Generator for migrations
## License
This is free sofware licensed under MIT license, see LICENSE file