CreateModel¶

class CreateModel(name, fields, options=None, bases=None, managers=None)[原始碼]¶

在專案歷史記錄中建立新的模型，並在資料庫中建立對應的資料表以與之匹配。

name 是模型名稱，如在 models.py 檔案中編寫的那樣。

fields 是 (field_name, field_instance) 的 2 元組列表。欄位實例應該是未綁定的欄位（因此僅 models.CharField(...)，而不是從另一個模型取得的欄位）。

options 是模型 Meta 類別中值的可選字典。

bases 是此模型要繼承的其他類別的可選清單；如果想要依賴另一個模型（因此繼承自歷史版本），則可以同時包含類別物件和 "appname.ModelName" 格式的字串。如果未提供，則預設為繼承標準 models.Model。

managers 採用 (manager_name, manager_instance) 的 2 元組列表。列表中的第一個管理員將是遷移期間此模型的預設管理員。

DeleteModel¶

class DeleteModel(name)[原始碼]¶

從專案歷史記錄中刪除模型，並從資料庫中刪除其資料表。

RenameModel¶

class RenameModel(old_name, new_name)[原始碼]¶

將模型從舊名稱重新命名為新名稱。

如果您一次變更模型名稱及其許多欄位，您可能必須手動新增此項目；對於自動偵測器而言，這看起來像是您刪除了具有舊名稱的模型並新增了一個具有不同名稱的新模型，並且它建立的遷移將會遺失舊資料表中的任何資料。

AlterModelTable¶

class AlterModelTable(name, table)[原始碼]¶

變更模型的資料表名稱（db_table Meta 子類別上的選項）。

AlterModelTableComment¶

class AlterModelTableComment(name, table_comment)[原始碼]¶

變更模型的資料表註解（db_table_comment 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_with_respect_to 選項在 Meta 子類別上所需的 _order 欄位。

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) - 通常是因為遷移將非可為空的欄位新增至表格，並且需要一個預設值來放入現有資料列。它不會影響直接在資料庫中設定預設值的行為 - Django 永遠不會設定資料庫預設值，而始終在 Django ORM 程式碼中套用它們。

RemoveField¶

class RemoveField(model_name, name)[原始碼]¶

從模型中移除欄位。

請記住，當還原時，這實際上是將欄位新增至模型。如果欄位可為空，或者如果它具有可用於填入重新建立之資料行的預設值，則該操作是可逆的（除了任何資料遺失之外，這是不可逆的）。如果欄位不可為空且沒有預設值，則該操作是不可逆的。

AlterField¶

class AlterField(model_name, name, field, preserve_default=True)[原始碼]¶

變更欄位的定義，包括變更其類型、null、unique、db_column 和其他欄位屬性。

preserve_default 引數表示欄位的預設值是永久的，應該被烘焙到專案狀態中 (True)，還是暫時的，僅用於此遷移 (False) - 通常是因為遷移正在將可為空的欄位變更為非可為空的欄位，並且需要一個預設值來放入現有資料列。它不會影響直接在資料庫中設定預設值的行為 - Django 永遠不會設定資料庫預設值，而始終在 Django ORM 程式碼中套用它們。

請注意，並非所有變更都可以在所有資料庫上進行 - 例如，在大多數資料庫上，您無法將文字類型欄位（如 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)[原始碼]¶

從具有 model_name 的模型中移除名為 name 的索引。

RenameIndex¶

class RenameIndex(model_name, new_name, old_name=None, old_fields=None)[原始碼]¶

在具有 model_name 的模型的資料庫表格中重新命名索引。必須提供 old_name 和 old_fields 其中之一。old_fields 是字串的可迭代物件，通常對應於 index_together 的欄位（Django 5.1 之前的選項）。

在不支援索引重新命名陳述式的資料庫（SQLite 和 MariaDB < 10.5.2）上，該操作將會捨棄並重新建立索引，這可能會很耗費資源。

AddConstraint¶

class AddConstraint(model_name, constraint)[原始碼]¶

在具有 model_name 的模型的資料庫表格中建立約束。

RemoveConstraint¶

class RemoveConstraint(model_name, name)[原始碼]¶

從具有 model_name 的模型中移除名為 name 的約束。

RunSQL¶

class RunSQL(sql, reverse_sql=None, state_operations=None, hints=None, elidable=False)[原始碼]¶

允許在資料庫上執行任意 SQL - 這對於 Django 不直接支援的資料庫後端的更進階功能很有用。

sql 和 reverse_sql （如果提供）應該是要在資料庫上執行的 SQL 字串。在大多數資料庫後端（除了 PostgreSQL 之外的所有後端）上，Django 會在執行 SQL 之前將 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)[原始碼]¶

這是一個高度專業化的操作，可讓您混合搭配操作的資料庫（schema 變更）和狀態（自動偵測器驅動）方面。

它接受兩個操作列表。當被要求套用狀態時，它將使用 state_operations 列表（這是 RunSQL 的 state_operations 引數的通用版本）。當被要求對資料庫套用變更時，它將使用 database_operations 列表。

如果資料庫的實際狀態和 Django 對狀態的檢視失去同步，這可能會破壞遷移框架，甚至導致資料遺失。請務必謹慎並仔細檢查您的資料庫和狀態操作。您可以使用 sqlmigrate 和 dbshell 來檢查您的資料庫操作。您可以使用 makemigrations，尤其是搭配 --dry-run，來檢查您的狀態操作。

如需使用 SeparateDatabaseAndState 的範例，請參閱 變更 ManyToManyField 以使用 through 模型。