Django 遷移壓縮（squashmigrations）與手動檢查指南

更新日期： 2024 年 12 月 26 日

在 Django 的遷移系統中，隨著應用程序的持續開發，遷移文件可能會變得繁多且複雜。

為了簡化遷移歷史並提升可維護性，可以使用壓縮遷移（squashmigrations）功能。

壓縮會將多個遷移文件合併為一個單一文件，並保持資料庫與遷移文件的一致性。

然而，壓縮遷移過程並不會直接檢查資料庫的現有結構，而是基於遷移文件內容生成結果。

因此，當遷移文件中存在重複操作（如欄位重複添加）時，仍需手動進行檢查與修正。

本指南將詳細說明壓縮遷移的行為及具體操作步驟。

壓縮遷移的行為原理

當執行以下命令時：

python manage.py squashmigrations users 0004 0005

Django 的行為如下：

基於遷移文件內容處理

• 壓縮過程是基於遷移文件內容，而非資料庫結構。
• Django 提取 0004 和 0005 中的所有操作（如新增欄位、修改欄位等），但不會檢查資料庫是否已經存在相應的欄位或表。

合併重疊的操作

• 如果兩個遷移中有重疊的操作，Django 無法自動判斷是否有衝突。例如：
  • 0004 中添加了欄位 freelancer_verified，但該欄位已在初始遷移 0001 定義。
  • 0005 中修改了該欄位的屬性（如設置 null=True）。

生成壓縮文件

• 壓縮結果是一個新的遷移文件（如 0004_squashed_0005.py），包含所有操作的合併結果。
• 重疊或不必要的操作（如重複添加欄位）仍可能保留，需手動修正。

壓縮後的手動檢查與修正

壓縮完成後，需檢查生成的遷移文件是否合理，並移除重複或衝突的操作。

檢查重複操作

打開生成的壓縮文件（如 0004_squashed_0005.py），查找不必要的操作。
例如，以下重複操作可能需要刪除：

migrations.AddField(
    model_name='profile',
    name='freelancer_verified',
    field=models.BooleanField(default=False),
),

確保修改操作正確

保留合理的操作，例如修改欄位屬性：

migrations.AlterField(
    model_name='profile',
    name='freelancer_verified',
    field=models.BooleanField(null=True),
),

刪除不必要的文件

若壓縮完成後確認新文件有效，舊文件（如 0004 和 0005）可以選擇性刪除，但需確保團隊環境一致。

壓縮後的資料庫應用行為

在壓縮文件生成並修正後，執行以下命令應用變更：

python manage.py migrate

Django 在執行時的行為如下：

1. 無需重複應用已存在的結構：
   • 若資料庫已經包含 freelancer_verified 欄位，則新增操作會被跳過。
2. 應用修改操作：
   • 例如，若 0005 中包含欄位屬性修改（如 null=True），則該操作會正常執行。

壓縮遷移的具體步驟

以下是進行壓縮的完整步驟，適用於本案例：

回滾到無問題的狀態

回滾資料庫至上一個無衝突的遷移點（如 0003）：

python manage.py migrate users 0003

執行壓縮命令

執行以下命令壓縮遷移文件：

python manage.py squashmigrations users 0004 0005

檢查壓縮文件

打開生成的壓縮文件，檢查操作是否合理，手動移除重複或不必要的操作。

應用新的壓縮文件

確認壓縮文件無誤後，執行遷移以驗證壓縮結果：

python manage.py migrate

壓縮遷移的優勢與限制

優勢

• 簡化歷史：多個遷移文件合併為一個，減少文件數量，提升可讀性。
• 提升效率：適用於新環境初始化，避免逐步執行大量遷移文件。

限制

• 需要手動檢查：壓縮結果可能包含重複或衝突操作，需手動修正。
• 無法自動檢查資料庫狀態：壓縮僅基於文件內容，未考慮資料庫中實際存在的結構。

注意事項與建議

團隊協作中的一致性

壓縮後的遷移文件需提交到版本控制系統，確保團隊中所有開發者的環境保持一致。

測試環境驗證

在正式環境應用壓縮文件前，建議在測試環境中驗證文件有效性。

版本控制中的操作建議

壓縮遷移可能改變遷移歷史，需與團隊成員協調後執行。

範例總結

壓縮前的文件清單

0001_initial.py
0002_alter_profile_photo.py
0003_alter_profile_photo.py
0004_profile_freelancer_verified_profile_is_client_and_more.py
0005_alter_profile_freelancer_verified_and_more.py

壓縮後的文件清單

0001_initial.py
0002_alter_profile_photo.py
0003_alter_profile_photo.py
0004_squashed_0005.py

通過壓縮，遷移歷史得到了簡化，但需確認新文件中的操作正確且不重複。

總結

壓縮遷移是一種有效的工具，用於簡化遷移歷史和提升維護效率。

然而，其結果需手動檢查以移除潛在的重複或衝突操作。

在團隊環境中使用壓縮遷移時，需同步操作並在測試環境中驗證，確保資料庫與遷移文件的一致性。

如有疑問，請隨時尋求進一步指導！