Операции миграции

Файлы миграции состоят из одного или нескольких Operation объектов, которые декларативно записывают, что должна сделать миграция с вашей базой данных.

Django также использует эти Operation объекты, чтобы выяснить, как выглядели ваши модели в прошлом, и вычислить изменения, которые вы внесли в свои модели с последней миграцией, чтобы автоматически создавать ваши миграции; именно поэтому они декларативны, так как это означает, что Django может легко загрузить их все в память и выполнить их, не взаимодействуя с базой данных, чтобы выяснить, как должен выглядеть ваш проект.

Также есть более специализированные Operation объекты, которые предназначены для задач, таких как данные миграции и для расширенной ручного управления базой данных. Вы также можете написать свои собственные Operation классы, если хотите обобщить пользовательское изменение, которое вы часто делаете.

Если вам нужен пустой файл миграции для записи ваших собственных Operation объектов, используйте python manage.py makemigrations --empty yourappname, но имейте в виду, что ручное добавление операций изменения схемы может сбить с толку детектор автоматической миграции и привести к неправильному коду при последующих запусках команды makemigrations.

Все основные операции Django доступны из модуля django.db.migrations.operations.

Для ознакомительной информации см. руководство по миграциям.

Операции со схемой

CreateModel

class CreateModel(name, fields, options=None, bases=None, managers=None)

Создаёт новую модель в истории проекта и соответствующую таблицу в базе данных, чтобы соответствовать ей.

name — имя модели, как оно написано в файле models.py.

fields — список из 2-х кортежей (field_name, field_instance). Экземпляр поля должен быть свободным полем (только models.CharField(...), а не поле, взятое из другой модели).

options — необязательный словарь значений из класса Meta модели.

bases — необязательный список других классов, от которых должна наследоваться эта модель; он может содержать как объекты классов, так и строки в формате "appname.ModelName", если вы хотите зависеть от другой модели (то есть наследуете от исторической версии). Если он не указан, он по умолчанию наследуется от стандартной models.Model.

managers принимает список из 2-х кортежей (manager_name, manager_instance) . Первый менеджер в списке будет менеджером по умолчанию для этой модели во время миграций.

DeleteModel

class DeleteModel(name)

Удаляет модель из истории проекта и её таблицу из базы данных.

RenameModel

class RenameModel(old_name, new_name)

Переименовывает модель со старого имени на новое.

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

AlterModelTable

class AlterModelTable(name, table)

Изменяет имя таблицы модели (опцию db_table в подклассе Meta).

AlterUniqueTogether

class AlterUniqueTogether(name, unique_together)

Изменяет набор уникальных ограничений модели (опцию unique_together в подклассе Meta).

AlterIndexTogether

class AlterIndexTogether(name, index_together)

Изменяет набор пользовательских индексов модели (опцию index_together в подклассе Meta).

AlterOrderWithRespectTo

class AlterOrderWithRespectTo(name, order_with_respect_to)

Создаёт или удаляет столбец _order необходимый для опции order_with_respect_to в подклассе Meta.

AlterModelOptions

class AlterModelOptions(name, options)

Сохраняет изменения в различных опциях модели (настройки в Meta) модели, такие как permissions и verbose_name. Не влияет на базу данных, но сохраняет эти изменения для использования экземплярами RunPython. options должен быть словарем, сопоставляющим имена опций со значениями.

AlterModelManagers

class AlterModelManagers(name, managers)

Изменяет доступные менеджеры во время миграций.

AddField

class AddField(model_name, name, field, preserve_default=True)

Добавляет поле к модели. model_name — имя модели, name — имя поля, и field — экземпляр поля Field (то, что вы бы поместили в объявление поля в models.py — например, models.IntegerField(null=True)).

Аргумент preserve_default указывает, является ли значение по умолчанию поля постоянным и должно быть включено в состояние проекта (True), или временным и только для этой миграции (False) — обычно, когда миграция добавляет поле без NULL к таблице и ей нужно значение по умолчанию, чтобы поместить его в существующие строки. Это не влияет на поведение установки значений по умолчанию в базе данных напрямую — Django никогда не устанавливает значения по умолчанию в базе данных и всегда применяет их в коде Django ORM.

RemoveField

class RemoveField(model_name, name)

Удаляет поле из модели.

Помните, что при обращении эта операция фактически добавляет поле к модели. Операция обратима (кроме потери данных, которая необратима), если поле nullable или имеет значение по умолчанию, которое можно использовать для заполнения воссозданного столбца. Если поле не nullable и не имеет значения по умолчанию, операция необратима.

AlterField

class AlterField(model_name, name, field, preserve_default=True)

Изменяет определение поля, включая изменения его типа, null, unique, db_column и других атрибутов поля.

Аргумент preserve_default указывает, является ли значение по умолчанию поля постоянным и должно быть включено в состояние проекта (True), или временным и только для этой миграции (False) — обычно, когда миграция изменяет nullable поле на не nullable и ей нужно значение по умолчанию, чтобы поместить его в существующие строки. Это не влияет на поведение установки значений по умолчанию в базе данных напрямую — Django никогда не устанавливает значения по умолчанию в базе данных и всегда применяет их в коде Django ORM.

Обратите внимание, что не все изменения возможны во всех базах данных — например, вы не можете изменить поле типа text, такое как models.TextField(), на поле числового типа, такое как models.IntegerField(), в большинстве баз данных.

RenameField

class RenameField(model_name, old_name, new_name)

Изменяет имя поля (и, если не установлено db_column, его имя столбца).

AddIndex

class AddIndex(model_name, index)

Создаёт индекс в таблице базы данных для модели с model_name. index — экземпляр класса Index.

RemoveIndex

class RemoveIndex(model_name, name)

Удаляет индекс с именем name из модели с model_name.

AddConstraint

class AddConstraint(model_name, constraint)

Создаёт ограничение в таблице базы данных для модели с model_name.

RemoveConstraint

class RemoveConstraint(model_name, name)

Удаляет ограничение с именем name из модели с model_name.

Специальные операции

RunSQL

class RunSQL(sql, reverse_sql=None, state_operations=None, hints=None, elidable=False)

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

sql, и reverse_sql, если предоставлены, должны быть строками SQL-запросов, которые нужно выполнить в базе данных. В большинстве баз данных (кроме PostgreSQL) Django разделит SQL-запрос на отдельные операторы перед выполнением.

Вы также можете передать список строк или 2-кортежей. Последний используется для передачи запросов и параметров так же, как в cursor.execute(). Эти три операции эквивалентны:

migrations.RunSQL("INSERT INTO musician (name) VALUES ('Reinhardt');")
migrations.RunSQL([("INSERT INTO musician (name) VALUES ('Reinhardt');", None)])
migrations.RunSQL([("INSERT INTO musician (name) VALUES (%s);", ['Reinhardt'])])

Если вам нужно включить в запрос буквальные знаки процента, необходимо удвоить их, если вы передаёте параметры.

reverse_sql запросы выполняются при отмене миграции. Они должны отменить то, что выполняется sql запросами. Например, чтобы отменить вышеуказанную вставку с помощью удаления:

migrations.RunSQL(
    sql=[("INSERT INTO musician (name) VALUES (%s);", ['Reinhardt'])],
    reverse_sql=[("DELETE FROM musician where name=%s;", ['Reinhardt'])],
)

Если reverse_sql установлено в значение None (по умолчанию), операция RunSQL необратима.

Аргумент state_operations позволяет указать операции, которые эквивалентны SQL в терминах состояния проекта. Например, если вы вручную создаёте столбец, вы должны передать в список операцию AddField здесь, чтобы автодетектор всё ещё имел актуальное состояние модели. Если вы этого не сделаете, при следующем запуске makemigrations, он не обнаружит операции добавления поля и попытается запустить её снова. Например:

migrations.RunSQL(
    "ALTER TABLE musician ADD COLUMN name varchar(255) NOT NULL;",
    state_operations=[
        migrations.AddField(
            'musician',
            'name',
            models.CharField(max_length=255),
        ),
    ],
)

Необязательный аргумент hints будет передан как **hints методу allow_migrate() роутеров баз данных, чтобы помочь им принимать решения о маршрутизации. Смотрите Подсказки для получения более подробной информации о подсказках для баз данных.

Необязательный аргумент elidable определяет, будет ли операция удалена (исключена) при объединении миграций.

RunSQL.noop

Передайте атрибут RunSQL.noop к sql или reverse_sql, когда вы хотите, чтобы операция ничего не делала в данном направлении. Это особенно полезно для обеспечения обратимости операции.

RunPython

class RunPython(code, reverse_code=None, atomic=None, hints=None, elidable=False)

Выполняет пользовательский Python-код в историческом контексте. code (и reverse_code, если предоставлены) должны быть вызываемыми объектами, которые принимают два аргумента; первый — экземпляр django.apps.registry.Apps, содержащий исторические модели, соответствующие положению операции в истории проекта, а второй — экземпляр SchemaEditor.

Аргумент reverse_code вызывается при отмене миграций. Эта вызываемая функция должна отменить то, что сделано в вызываемой функции code, чтобы миграция была обратимой. Если reverse_code установлено в значение None (по умолчанию), операция RunPython необратима.

Необязательный аргумент hints будет передан как **hints методу allow_migrate() роутеров баз данных, чтобы помочь им принимать решения о маршрутизации. Смотрите Подсказки для получения более подробной информации о подсказках для баз данных.

Необязательный аргумент elidable определяет, будет ли операция удалена (исключена) при объединении миграций.

Рекомендуется писать код в виде отдельной функции над классом Migration в файле миграции и передавать её в RunPython. Вот пример использования RunPython для создания некоторых начальных объектов в модели Country.

from django.db import migrations

def forwards_func(apps, schema_editor):
    # We get the model from the versioned app registry;
    # if we directly import it, it'll be the wrong version
    Country = apps.get_model("myapp", "Country")
    db_alias = schema_editor.connection.alias
    Country.objects.using(db_alias).bulk_create([
        Country(name="USA", code="us"),
        Country(name="France", code="fr"),
    ])

def reverse_func(apps, schema_editor):
    # forwards_func() creates two Country instances,
    # so reverse_func() should delete them.
    Country = apps.get_model("myapp", "Country")
    db_alias = schema_editor.connection.alias
    Country.objects.using(db_alias).filter(name="USA", code="us").delete()
    Country.objects.using(db_alias).filter(name="France", code="fr").delete()

class Migration(migrations.Migration):

    dependencies = []

    operations = [
        migrations.RunPython(forwards_func, reverse_func),
    ]

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

Подобно RunSQL, убедитесь, что если вы изменяете схему внутри этого, вы делаете это вне сферы Django модели (например, триггеры) или что вы используете SeparateDatabaseAndState, чтобы добавить операции, которые отражают ваши изменения в состоянии модели — в противном случае, версионированная ORM и автодетектор перестанут работать корректно.

По умолчанию RunPython будет выполнять своё содержимое внутри транзакции в базах данных, которые не поддерживают транзакции DDL (например, MySQL и Oracle). Это должно быть безопасно, но может привести к сбою, если вы попытаетесь использовать предоставленное в этих бекендах schema_editor; в этом случае передайте atomic=False в операцию RunPython.

В базах данных, которые поддерживают транзакции DDL (SQLite и PostgreSQL), операции RunPython не имеют автоматически добавленных транзакций, кроме транзакций, созданных для каждой миграции. Таким образом, в PostgreSQL, например, следует избегать объединения изменений схемы и операций RunPython в одной миграции, иначе могут возникнуть ошибки, подобные OperationalError: cannot ALTER TABLE "mytable" because it has pending trigger events.

Если у вас другая база данных и вы не уверены, поддерживает ли она транзакции DDL, проверьте атрибут django.db.connection.features.can_rollback_ddl.

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

static RunPython.noop()

Передайте метод RunPython.noop к code или reverse_code, когда вы хотите, чтобы операция ничего не делала в данном направлении. Это особенно полезно для обеспечения обратимости операции.

SeparateDatabaseAndState

class SeparateDatabaseAndState(database_operations=None, state_operations=None)

Высокоспециализированная операция, которая позволяет совмещать аспекты базы данных (изменения схемы) и состояния (питание автодетектора) операций.

Она принимает два списка операций. При запросе применения состояния она будет использовать список state_operations (это обобщённая версия аргумента state_operations RunSQL). При запросе применения изменений в базе данных она будет использовать список database_operations.

Если фактическое состояние базы данных и представление состояния Django разойдутся, это может нарушить работу фреймворка миграций, даже приводя к потере данных. Стоит проявлять осторожность и тщательно проверять ваши операции с базой данных и состоянием. Вы можете использовать sqlmigrate и dbshell для проверки ваших операций с базой данных. Вы можете использовать makemigrations, особенно с --dry-run, для проверки ваших операций с состоянием.

Пример использования SeparateDatabaseAndState, см. Изменение ManyToManyField для использования модели through.

Написание собственных операций

Операции имеют относительно простой API, и они разработаны таким образом, что вы можете легко написать свои собственные для дополнения встроенных Django операций. Основная структура Operation выглядит так:

from django.db.migrations.operations.base import Operation

class MyCustomOperation(Operation):

    # If this is False, it means that this operation will be ignored by
    # sqlmigrate; if true, it will be run and the SQL collected for its output.
    reduces_to_sql = False

    # If this is False, Django will refuse to reverse past this operation.
    reversible = False

    def __init__(self, arg1, arg2):
        # Operations are usually instantiated with arguments in migration
        # files. Store the values of them on self for later use.
        pass

    def state_forwards(self, app_label, state):
        # The Operation should take the 'state' parameter (an instance of
        # django.db.migrations.state.ProjectState) and mutate it to match
        # any schema changes that have occurred.
        pass

    def database_forwards(self, app_label, schema_editor, from_state, to_state):
        # The Operation should use schema_editor to apply any changes it
        # wants to make to the database.
        pass

    def database_backwards(self, app_label, schema_editor, from_state, to_state):
        # If reversible is True, this is called when the operation is reversed.
        pass

    def describe(self):
        # This is used to describe what the operation does in console output.
        return "Custom Operation"

Вы можете взять эту модель и работать с ней, хотя мы рекомендуем изучить встроенные Django операции в django.db.migrations.operations — они охватывают множество примеров использования полувнутренних аспектов фреймворка миграций, таких как ProjectState и шаблонов получения исторических моделей, а также ModelState и шаблонов изменения исторических моделей в state_forwards().

Некоторые моменты, на которые стоит обратить внимание:

• Вам не нужно много знать о ProjectState для написания миграций; просто знайте, что у него есть свойство apps, которое предоставляет доступ к регистру приложений (на котором вы затем можете вызвать get_model).
• database_forwards и database_backwards оба получают два состояния; они представляют собой разницу, которую метод state_forwards применил бы, но предоставляются для удобства и скорости.

• Если вы хотите работать с классами моделей или экземплярами моделей из аргумента from_state в database_forwards() или database_backwards(), вы должны отобразить состояния моделей с помощью метода clear_delayed_apps_cache(), чтобы сделать связанные модели доступными:

  def database_forwards(self, app_label, schema_editor, from_state, to_state):
      # This operation should have access to all models. Ensure that all models are
      # reloaded in case any are delayed.
      from_state.clear_delayed_apps_cache()
      ...
  

• to_state в методе database_backwards — это старое состояние; то есть состояние, которое станет текущим после завершения обратной миграции.
• Вы можете увидеть реализации references_model в встроенных операциях; это часть кода автоматического обнаружения и не имеет значения для пользовательских операций.

В качестве примера давайте создадим операцию, которая загружает расширения PostgreSQL (которые содержат некоторые из более интересных функций PostgreSQL). Поскольку нет изменений состояния модели, всё, что она делает, — это выполняет одну команду:

from django.db.migrations.operations.base import Operation

class LoadExtension(Operation):

    reversible = True

    def __init__(self, name):
        self.name = name

    def state_forwards(self, app_label, state):
        pass

    def database_forwards(self, app_label, schema_editor, from_state, to_state):
        schema_editor.execute("CREATE EXTENSION IF NOT EXISTS %s" % self.name)

    def database_backwards(self, app_label, schema_editor, from_state, to_state):
        schema_editor.execute("DROP EXTENSION %s" % self.name)

    def describe(self):
        return "Creates extension %s" % self.name