CODEWITHSUNDEEP
djangodjango-migrations
geckon
geckon

Reputation: 8774

Is it safe to rename Django migrations file?

Since Django 1.8 the makemigrations command has a --name, -n option to specify custom name for the created migrations file.

I'd like to know whether it's safe in older versions of Django to create the migrations file with the automatically generated name and then rename the file manually. It seems to work as expected. Are there any potential risks?

Upvotes: 55

Views: 15308

Answers (2)

oden
oden

Reputation: 3651

This is happens in Django every time migrations are squashed. A new file is generated thats contains the class variable replaces, this lists the migration files that are being replaced.

So to rename a file migration file add in the following variable in the Migration class:

replaces = [('app name', 'migration file name'), ]

And everything works like it did before the file change.

Upvotes: 24

knbk
knbk

Reputation: 53719

This works, with a minor caveat: Django will no longer know that the renamed migration is applied.

So the steps to renaming a migration are:

  1. Rename the file.
  2. Repoint any dependencies to the new file.
  3. If the renamed migration was already applied, apply it again using --fake.

If it's a brand new migration, 2 and 3 won't apply, and it's perfectly fine to rename them.

Upvotes: 58

Related Questions