Как создавать миграции базы данных

В этом документе описано, как структурировать и писать миграции базы данных для различных сценариев, с которыми вы можете столкнуться. Для ознакомления с материалами по миграциям, см. руководство по теме.

Миграции данных и несколько баз данных

При использовании нескольких баз данных вам может потребоваться определить, следует ли выполнять миграцию для конкретной базы данных. Например, вы можете захотеть выполнить миграцию только для определенной базы данных.

Для этого вы можете проверить псевдоним подключения к базе данных внутри RunPython операции, посмотрев на атрибут schema_editor.connection.alias.

from django.db import migrations


def forwards(apps, schema_editor):
    if schema_editor.connection.alias != "default":
        return
    # Your migration code goes here


class Migration(migrations.Migration):
    dependencies = [
        # Dependencies to other migrations
    ]

    operations = [
        migrations.RunPython(forwards),
    ]

Вы также можете предоставить подсказки, которые будут переданы методу allow_migrate() маршрутизаторов баз данных в качестве **hints.

class MyRouter:
    def allow_migrate(self, db, app_label, model_name=None, **hints):
        if "target_db" in hints:
            return db == hints["target_db"]
        return True

Затем, чтобы использовать это в своих миграциях, сделайте следующее:

from django.db import migrations


def forwards(apps, schema_editor):
    # Your migration code goes here
    ...


class Migration(migrations.Migration):
    dependencies = [
        # Dependencies to other migrations
    ]

    operations = [
        migrations.RunPython(forwards, hints={"target_db": "default"}),
    ]

Если ваша RunPython или RunSQL операция затрагивает только одну модель, рекомендуется передавать model_name в качестве подсказки, чтобы сделать её максимально прозрачной для маршрутизатора. Это особенно важно для многоразовых и сторонних приложений.

Миграции, добавляющие уникальные поля

Применение «обычной» миграции, добавляющей уникальное необязательное поле в таблицу с существующими строками, приведет к ошибке, поскольку значение, используемое для заполнения существующих строк, генерируется только один раз, нарушая уникальное ограничение.

Поэтому необходимо выполнить следующие шаги. В этом примере мы добавим необязательное поле UUIDField со значением по умолчанию. Измените соответствующее поле в соответствии с вашими потребностями.

• Добавьте поле в вашу модель с аргументами default=uuid.uuid4 и unique=True (выберите подходящее значение по умолчанию для типа добавляемого поля).
• Запустите команду makemigrations. Это должно сгенерировать миграцию с операцией AddField.
• Сгенерируйте два пустых файла миграции для одного и того же приложения, дважды запустив makemigrations myapp --empty. Мы переименовали файлы миграций, чтобы придать им осмысленные имена в примерах ниже.

• Скопируйте операцию AddField из сгенерированной миграции (первый из трёх новых файлов) в последнюю миграцию, измените AddField на AlterField, и добавьте импорты uuid и models. Например:

  0006_remove_uuid_null.py

  # Generated by Django A.B on YYYY-MM-DD HH:MM
  from django.db import migrations, models
  import uuid
  
  
  class Migration(migrations.Migration):
      dependencies = [
          ("myapp", "0005_populate_uuid_values"),
      ]
  
      operations = [
          migrations.AlterField(
              model_name="mymodel",
              name="uuid",
              field=models.UUIDField(default=uuid.uuid4, unique=True),
          ),
      ]
  

• Измените первый файл миграции. Сгенерированный класс миграции должен выглядеть примерно так:

  0004_add_uuid_field.py

  class Migration(migrations.Migration):
      dependencies = [
          ("myapp", "0003_auto_20150129_1705"),
      ]
  
      operations = [
          migrations.AddField(
              model_name="mymodel",
              name="uuid",
              field=models.UUIDField(default=uuid.uuid4, unique=True),
          ),
      ]
  

  Измените unique=True на null=True - это создаст промежуточное поле null и отложит создание уникального ограничения до тех пор, пока мы не заполним уникальные значения во всех строках.

• В первом пустом файле миграции добавьте операцию RunPython или RunSQL для генерации уникального значения (UUID в примере) для каждой существующей строки. Также добавьте импорт uuid. Например:

  0005_populate_uuid_values.py

  # Generated by Django A.B on YYYY-MM-DD HH:MM
  from django.db import migrations
  import uuid
  
  
  def gen_uuid(apps, schema_editor):
      MyModel = apps.get_model("myapp", "MyModel")
      for row in MyModel.objects.all():
          row.uuid = uuid.uuid4()
          row.save(update_fields=["uuid"])
  
  
  class Migration(migrations.Migration):
      dependencies = [
          ("myapp", "0004_add_uuid_field"),
      ]
  
      operations = [
          # omit reverse_code=... if you don't want the migration to be reversible.
          migrations.RunPython(gen_uuid, reverse_code=migrations.RunPython.noop),
      ]
  

• Теперь вы можете применить миграции как обычно с помощью команды migrate.

  Обратите внимание, что существует состояние гонки, если вы разрешаете создание объектов во время выполнения этой миграции. Объекты, созданные после AddField и до RunPython, будут иметь переписанные свои исходные uuid.

Неатомарные миграции

В базах данных, поддерживающих транзакции DDL (SQLite и PostgreSQL), миграции по умолчанию выполняются внутри транзакции. В таких случаях, как выполнение миграции данных для больших таблиц, вы можете предотвратить выполнение миграции в транзакции, установив атрибут atomic в False.

from django.db import migrations


class Migration(migrations.Migration):
    atomic = False

В такой миграции все операции выполняются без транзакции. Можно выполнить части миграции внутри транзакции, используя atomic() или передав atomic=True в RunPython.

Вот пример неатомарной миграции данных, которая обновляет большую таблицу меньшими порциями:

import uuid

from django.db import migrations, transaction


def gen_uuid(apps, schema_editor):
    MyModel = apps.get_model("myapp", "MyModel")
    while MyModel.objects.filter(uuid__isnull=True).exists():
        with transaction.atomic():
            for row in MyModel.objects.filter(uuid__isnull=True)[:1000]:
                row.uuid = uuid.uuid4()
                row.save()


class Migration(migrations.Migration):
    atomic = False

    operations = [
        migrations.RunPython(gen_uuid),
    ]

Атрибут atomic не влияет на базы данных, которые не поддерживают транзакции DDL (например, MySQL, Oracle). (Поддержка атомарных DDL-операций в MySQL относится к отдельным операциям, а не к нескольким операциям, заключенным в транзакцию, которая может быть отменена.)

Управление порядком миграций

Django определяет порядок применения миграций не по имени файла каждой миграции, а по построению графа, используя два свойства класса Migration: dependencies и run_before.

Если вы использовали команду makemigrations, вы, вероятно, уже видели dependencies в действии, потому что автоматически созданные миграции имеют это определённым в процессе создания.

Свойство dependencies объявляется так:

from django.db import migrations


class Migration(migrations.Migration):
    dependencies = [
        ("myapp", "0123_the_previous_migration"),
    ]

Обычно этого достаточно, но время от времени может потребоваться гарантировать, что ваша миграция выполняется *перед* другими миграциями. Это полезно, например, чтобы миграции сторонних приложений выполнялись *после* вашей замены AUTH_USER_MODEL.

Для этого поместите все миграции, которые должны зависеть от вашей, в атрибут run_before вашего класса Migration:

class Migration(migrations.Migration):
    ...

    run_before = [
        ("third_party_app", "0001_do_awesome"),
    ]

Предпочтительно использовать dependencies вместо run_before, если это возможно. Вы должны использовать run_before только в том случае, если нежелательно или непрактично указать dependencies в миграции, которую вы хотите запустить после той, которую пишете.

Миграция данных между сторонними приложениями

Вы можете использовать миграцию данных для перемещения данных из одного стороннего приложения в другое.

Если вы планируете удалить старое приложение позже, вам необходимо установить свойство dependencies на основе того, установлено ли старое приложение. В противном случае у вас будут отсутствующие зависимости после удаления старого приложения. Аналогично, вам нужно перехватить LookupError в вызове apps.get_model(), который извлекает модели из старого приложения. Этот подход позволяет развернуть ваш проект в любом месте, не устанавливая и не удаляя старое приложение предварительно.

Вот пример миграции:

from django.apps import apps as global_apps
from django.db import migrations


def forwards(apps, schema_editor):
    try:
        OldModel = apps.get_model("old_app", "OldModel")
    except LookupError:
        # The old app isn't installed.
        return

    NewModel = apps.get_model("new_app", "NewModel")
    NewModel.objects.bulk_create(
        NewModel(new_attribute=old_object.old_attribute)
        for old_object in OldModel.objects.all()
    )


class Migration(migrations.Migration):
    operations = [
        migrations.RunPython(forwards, migrations.RunPython.noop),
    ]
    dependencies = [
        ("myapp", "0123_the_previous_migration"),
        ("new_app", "0001_initial"),
    ]

    if global_apps.is_installed("old_app"):
        dependencies.append(("old_app", "0001_initial"))

Также подумайте, что должно произойти при отмене миграции. Вы можете ничего не делать (как в примере выше) или удалить часть или все данные из нового приложения. Соответственно настройте второй аргумент операции RunPython.

Изменение ManyToManyField для использования модели through

Если вы изменяете ManyToManyField для использования модели through, стандартная миграция удалит существующую таблицу и создаст новую, потеряв существующие связи. Чтобы этого избежать, можно использовать SeparateDatabaseAndState для переименования существующей таблицы в новое имя таблицы, сообщая детекторам миграций, что новая модель была создана. Вы можете проверить имя существующей таблицы с помощью sqlmigrate или dbshell. Вы можете проверить новое имя таблицы с помощью свойства _meta.db_table модели through. Ваша новая модель through должна использовать те же имена для ForeignKeyов, что и Django. Также, если ей нужны дополнительные поля, они должны быть добавлены в операции после SeparateDatabaseAndState.

Например, если у нас была модель Book с ManyToManyFieldсвязью с Author, мы могли бы добавить модель through AuthorBook с новым полем is_primary, как показано ниже:

from django.db import migrations, models
import django.db.models.deletion


class Migration(migrations.Migration):
    dependencies = [
        ("core", "0001_initial"),
    ]

    operations = [
        migrations.SeparateDatabaseAndState(
            database_operations=[
                # Old table name from checking with sqlmigrate, new table
                # name from AuthorBook._meta.db_table.
                migrations.RunSQL(
                    sql="ALTER TABLE core_book_authors RENAME TO core_authorbook",
                    reverse_sql="ALTER TABLE core_authorbook RENAME TO core_book_authors",
                ),
            ],
            state_operations=[
                migrations.CreateModel(
                    name="AuthorBook",
                    fields=[
                        (
                            "id",
                            models.AutoField(
                                auto_created=True,
                                primary_key=True,
                                serialize=False,
                                verbose_name="ID",
                            ),
                        ),
                        (
                            "author",
                            models.ForeignKey(
                                on_delete=django.db.models.deletion.DO_NOTHING,
                                to="core.Author",
                            ),
                        ),
                        (
                            "book",
                            models.ForeignKey(
                                on_delete=django.db.models.deletion.DO_NOTHING,
                                to="core.Book",
                            ),
                        ),
                    ],
                ),
                migrations.AlterField(
                    model_name="book",
                    name="authors",
                    field=models.ManyToManyField(
                        to="core.Author",
                        through="core.AuthorBook",
                    ),
                ),
            ],
        ),
        migrations.AddField(
            model_name="authorbook",
            name="is_primary",
            field=models.BooleanField(default=False),
        ),
    ]

Изменение необработанной модели на управляемую

Если вы хотите изменить необработанную модель (managed=False) на управляемую, вам необходимо удалить managed=False и сгенерировать миграцию перед внесением других изменений в схему модели, так как изменения схемы, которые появятся в миграции, содержащей операцию изменения Meta.managed, могут не быть применены.