1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
# Data Migrate
- [](https://rubygems.org/gems/data_migrate)
- [](http://opensource.org/licenses/MIT)
- [](https://travis-ci.org/ilyakatz/data-migrate)
- [](https://houndci.com)
Run data migrations alongside schema migrations.
Data migrations are stored in `db/data`. They act like schema
migrations, except they should be reserved for data migrations. For
instance, if you realize you need to titleize all your titles, this
is the place to do it.
## Why should I use this?
With data-migrate you can generate your migrations for data as you would schema
in your regular work flow.
For setting tasks that don't require any intermediate AR activity, like
dev and test, you stick with `db:migrate`. For production and QA, you
change their scripts to `db:migrate:with_data`. Of course you want to
test your migration, so you have the choice of `db:migrate:with_data` or
`data:migrate` to just capture that data change.
## What does it do?
Data migrations are stored in `db/data`. They act like schema
migrations, except they should be reserved for data migrations. For
instance, if you realize you need to titleize all yours titles, this
is the place to do it. Running any of the provided rake tasks also
creates a data schema table to mirror the usual schema migrations
table to track all migrations.
## Rails Support
Support Rails 5.0 through 6.0
### Important notes for older versions
#### v2
If you upgraded to Rails 4 while using `data_migrate` prior to version 2,
the gem wrote data migration versions into
`schema_migrations` table. After the fix, it was corrected to write into
`data_migrations`.
If you need to use these old migrations, add the following configuration
It is recommended to move all legacy migrations from `schema_migrations` table into `data_migrations` table
This may cause some unintended consequences. See [#22](https://github.com/ilyakatz/data-migrate/issues/22)
#### v1
If you've installed previous to v1.1.0, you'll want to delete the
`create_data_migrations_table` migration.
## Installation
Add the gem to your project
# Gemfile
gem 'data_migrate'
Then `bundle install` and you are ready to go.
So you know, when you use one of the provide rake tasks, a table
called `data_migrations` will be created in your database. This
is to mirror the way the standard `db` rake tasks work.
## Usage
### Generating Migrations
You can generate a data migration as you would a schema migration:
rails g data_migration add_this_to_that
### Rake Tasks
$> rake -T data
rake data:abort_if_pending_migrations # Raises an error if there are pending data migrations
rake data:dump # Create a db/data_schema.rb file that stores the current data version
rake data:forward # Pushes the schema to the next version (specify steps w/ STEP=n)
rake data:migrate # Migrate data migrations (options: VERSION=x, VERBOSE=false)
rake data:migrate:down # Runs the "down" for a given migration VERSION
rake data:migrate:redo # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x)
rake data:migrate:status # Display status of data migrations
rake data:migrate:up # Runs the "up" for a given migration VERSION
rake data:rollback # Rolls the schema back to the previous version (specify steps w/ STEP=n)
rake data:schema:load # Load data_schema.rb file into the database without running the data migrations
rake data:version # Retrieves the current schema version number for data migrations
rake db:abort_if_pending_migrations:with_data # Raises an error if there are pending migrations or data migrations
rake db:forward:with_data # Pushes the schema to the next version (specify steps w/ STEP=n)
rake db:migrate:down:with_data # Runs the "down" for a given migration VERSION
rake db:migrate:redo:with_data # Rollbacks the database one migration and re migrate up (options: STEP=x, VERSION=x)
rake db:migrate:status:with_data # Display status of data and schema migrations
rake db:migrate:up:with_data # Runs the "up" for a given migration VERSION
rake db:migrate:with_data # Migrate the database data and schema (options: VERSION=x, VERBOSE=false)
rake db:rollback:with_data # Rolls the schema back to the previous version (specify steps w/ STEP=n)
rake db:schema:load:with_data # Load both schema.rb and data_schema.rb file into the database
rake db:structure:load:with_data # Load both structure.sql and data_schema.rb file into the database
rake db:version:with_data # Retrieves the current schema version numbers for data and schema migrations
Tasks work as they would with the 'vanilla' db version. The 'with_data' addition to the 'db' tasks will run the task in the context of both the data and schema migrations. That is, rake db:rollback:with_data will check to see if it was a schema or data migration invoked last, and do that. Tasks invoked in that space also have an additional line of output, indicating if the action is performed on data or schema.
With 'up' and 'down', you can specify the option 'BOTH', which defaults to false. Using true, will migrate both the data and schema (in the desired direction) if they both match the version provided. Again, going up, schema is given precedence. Down its data.
`rake db:migrate:status:with_data` provides and additional column to indicate which type of migration.
### Configuration
`data_migrate` respects `ActiveRecord::Base.dump_schema_after_migration`. If it is set to `false`, data schema file will not be generated
By default, data migrations are added to the `db/data/` path.
You can override this setting in `config/initializers/data_migrate.rb`
```ruby
DataMigrate.configure do |config|
config.data_migrations_path = 'db/awesomepath/'
config.db_configuration = {
'host' => '127.0.0.1',
'database' => 'awesome_database',
'adapter' => 'mysql2',
'username' => 'root',
'password' => nil,
}
config.spec_name = 'primary'
end
```
## Capistrano Support
The gem comes with a capistrano task that can be used instead of `capistrano/rails/migrations`.
Just add this line to your Capfile:
```ruby
require 'capistrano/data_migrate'
```
From now on capistrano will run `rake db:migrate:with_data` in every deploy.
### Contributing
## Testing
Run tests for a specific version of Rails
```
bundle exec appraisal install
bundle exec appraisal rails-5.1 rspec
bundle exec appraisal rails-5.2 rspec
bundle exec appraisal rails-6.0 rspec
```
## Thanks
[Andrew J Vargo](http://github.com/ajvargo) Andrew was the original creator and maintainer of this project!
[Jeremy Durham](http://jeremydurham.com/) for fleshing out the idea and providing guidance.
You! Yes, you. Thanks for checking it out.
|
