Show pending migrations in rails

Question

Is there a rake task that shows the pending migrations in a rails app?

score 308 · Answer 1 · edited Sep 20 '19 at 06:57

308

rake db:migrate:status (Rails 3 to 5) or rails db:migrate:status (Rails 5) will accomplish this. See this commit.

up means the migration has been run. down means the migration has not been run.

edited Sep 20 '19 at 06:57

Malik Shahzad

6,703
3
37
49

answered Jan 25 '11 at 17:58

jrdioko

32,230
28
81
120

I'm getting `Don't know how to build task 'db:migrate:status'` on rails 3.2.8 – Peter Ehrlich Oct 10 '12 at 21:00
1

@PeterEhrlich: Does it not show up in `rake -T` but the other ones do? – jrdioko Oct 11 '12 at 00:37
2

bundle exec rake db:migrate:status – Nadeem Yasin Mar 22 '13 at 11:09
2

How do you read the output of this command? If the status of a row is "down", does that mean it's a pending migration? – Dennis Feb 13 '15 at 15:00
13

`up` means the migration has been run. `down` means the migration has not been run. – Josh Aug 02 '15 at 19:55
check out this gist for more rake tasks not in `rake -T` @jrdioko https://gist.github.com/amejiarosario/2950888 – mswieboda Feb 17 '16 at 18:38

score 45 · Answer 2 · answered Aug 28 '09 at 20:04

45

There is rake db:abort_if_pending_migrations (at least in Rails 2.3.3, not sure when it was introduced). The description says 'Raises an error if there are pending migrations'. This seems to be used more as a prerequisite for other tasks, but I'm guessing you could use it for your purposes.

EDIT: Here is an example of the output after having just generated and not run a 'test' migration

rails_project theIV$ rake db:abort_if_pending_migrations
(in /Users/theIV/Sites/rails_project/)
You have 1 pending migrations:
  20090828200602 Test
Run "rake db:migrate" to update your database then try again.

answered Aug 28 '09 at 20:04

theIV

25,434
5
54
58

I love adding this to orchestrate dependencies between rails containers – Vincent De Smet Mar 28 '17 at 09:42
Still there in Rails 4.1.16 – Magne Oct 31 '17 at 08:46
Works in rails 5.1.3 as well – Wilson Silva Nov 14 '17 at 10:21

Deepak Mahakale · Answer 3 · 2023-01-25T05:53:37.320

20

This command will list all migrations with their status (UP or DOWN)

Rails 3 and 4

rake db:migrate:status

Rails 5 and above

rake db:migrate:status

# Or

rails db:migrate:status

This will return something like

database: blog_development

 Status   Migration ID    Migration Name
--------------------------------------------------
   up     20210131124730  Create articles
  down    20210131124801  Create users

edited Jan 25 '23 at 05:53

answered Sep 20 '16 at 13:59

Deepak Mahakale

22,834
10
68
88

score 15 · Answer 4 · answered Feb 03 '12 at 16:51

15

rake db:version will accomplish this on Rails 2.

answered Feb 03 '12 at 16:51

gerryster

650
1
6
11

Also valid in rails 3.2.18 – Ian Vaughan Feb 13 '15 at 17:57

score 14 · Answer 5 · answered Oct 15 '18 at 14:45

14

This works for rails 5.2

ActiveRecord::Base.connection.migration_context.needs_migration?

answered Oct 15 '18 at 14:45

Sairam

2,708
1
25
34

score 4 · Answer 6 · answered Jan 28 '19 at 05:44

4

If you want to see how much migration is done or pending you can see using below command.

rails db:migrate:status

More on this link: Rails Active Record Migration

answered Jan 28 '19 at 05:44

Foram

483
5
12

score 3 · Answer 7 · answered May 26 '19 at 16:57

If you need a bash one-liner to determine whether to run a migration or not (e.g., only migrate in a Heroku release phase command when there is a pending migration), this works:

(rails db:migrate:status | grep "^\s*down") && rails db:migrate || echo "No pending migrations found."

score 2 · Answer 8 · answered Aug 28 '09 at 20:14

2

Try rake -h (help) and have a look at rake -n (= rake --dry-run). So probably something like rake -n db:migrate should get you what you want.

answered Aug 28 '09 at 20:14

John Lockwood

3,787
29
27

3

That won't work. It just prints: ** Invoke db:migrate (first_time) ** Invoke environment (first_time) ** Execute (dry run) environment ** Execute (dry run) db:migrate – jrdioko Jan 24 '11 at 19:25

score 2 · Answer 9 · answered May 12 '18 at 10:30

Might not quite be what OP is asking for, but if you just need to quickly check if any migrations are pending for use in a rake task, without resorting to

rake db:migrate:status | grep down (might not work if you're on Windows)

ActiveRecord::Migration.check_pending! (raises ActiveRecord::PendingMigrationError that you need to rescue)

you can use needs_migration? method: https://apidock.com/rails/v4.0.2/ActiveRecord/Migrator/needs_migration%3F/class

`ActiveRecord::Migrator.needs_migration?` in Rails 5.1 – niborg Jan 20 '19 at 17:16 — niborg, Jan 20 '19 at 17:16

score 1 · Answer 10 · answered Jan 11 '17 at 07:01

1

Following command to check migration status:

rake db:migrate:status

OR

when you run your server, it will display a message to run your pending migration first.

answered Jan 11 '17 at 07:01

puneet18

4,341
2
21
27

Show pending migrations in rails

10 Answers10

Linked