Django Migrations

🚀 Django 遷移 MCP 服務

Django 遷移 MCP（Migration Control Panel）服務是一款專門用於管理 Django 項目數據庫遷移的工具。它藉助完整的 API 和控制檯界面，極大地簡化了數據庫遷移流程，為開發者提供了便捷高效的遷移管理體驗。

🚀 快速開始

Django 遷移 MCP 服務提供了完整的 API 和控制檯界面，可幫助你輕鬆管理 Django 項目的數據庫遷移。你可以按照以下步驟進行操作：

1. 安裝服務。
2. 配置 Django 項目。
3. 通過命令行工具或 API 執行遷移操作。

✨ 主要特性

• 統一的控制面板：藉助簡單的 HTTP 接口，即可管理所有遷移操作。
• 自動化流程：自動檢測未應用的遷移並執行，節省時間和精力。
• 日誌記錄與跟蹤：詳細記錄每一步操作和結果，方便調試和審計。
• 可擴展性：支持自定義命令和插件，滿足多樣化需求。

📦 安裝指南

開發環境

# 克隆倉庫
git clone git@github.com:your-repository.git
cd django-migration-mcp

# 創建虛擬環境並安裝依賴
python -m venv env
source env/bin/activate  # 在 Windows 上使用 .\env\Scripts\activate
pip install -r requirements.txt

生產環境

# 安裝服務（假設已克隆倉庫）
sudo systemctl enable simple_http_server
sudo systemctl start simple_http_server

💻 使用示例

基礎用法

Django 項目配置

在 Django 項目的 settings.py 中添加以下配置：

MIGRATION_MCP_ENABLED = True
MIGRATION_MCP_URL = 'http://localhost:8000'  # 根據實際情況修改

命令行工具

可以通過命令行直接使用 MCP 服務：

# 查看幫助信息
python manage.py migration_mcp --help

# 執行所有未應用的遷移
python manage.py migrate_all

# 指定應用執行遷移
python manage.py migrate app_name

# 回滾最後一次遷移
python manage.py rollback

# 顯示當前數據庫狀態
python manage.py show_migrations

高級用法

API 文檔

請求格式

所有請求都需要通過 POST 方式發送到 /mcp 端點，幷包含一個 JSON 格式的正文：

{
    "method": "方法名",
    "params": {
        "參數1": 值,
        "參數2": 值
    }
}

具體接口

1. 列出所有遷移

   curl -X POST http://localhost:8000/mcp \
     -H "Content-Type: application/json" \
     -d '{"method": "list_migrations"}'
   

2. 執行指定應用的遷移

   curl -X POST http://localhost:8000/mcp \
     -H "Content-Type: application/json" \
     -d '{"method": "migrate", "params": {"app": "your_app"}}'
   

3. 回滾指定應用的遷移

   curl -X POST http://localhost:8000/mcp \
     -H "Content-Type: application/json" \
     -d '{"method": "rollback", "params": {"app": "your_app"}}'
   

📚 詳細文檔

高級功能

Redis 集成

通過集成 Redis，可以實現更高效的遷移管理和狀態跟蹤。

日誌系統

內置的日誌記錄模塊可以幫助開發者快速定位問題。日誌文件默認保存在 mcp_logs/ 目錄下。

安全措施

• 認證：支持基本認證和 Token 認證。
• 權限控制：可以根據不同的用戶設置不同的操作權限。

Docker 使用指南

快速啟動

docker run -d --name django-migration-mcp \
  -e DJANGO_SETTINGS_MODULE=your_project.settings \
  -p 8000:8000 \
  your-django-mcp-image

進入交互式環境

docker exec -it django-migration-mcp /bin/bash

網絡配置

創建網絡

docker network create mcp-network

連接網絡

docker network connect mcp-network your-container-name

監控與維護

日誌監控

docker logs -f django-migration-mcp

自動重啟策略

在啟動命令中添加重啟策略：

docker run --restart unless-stopped ...

FAQ

1. 如何處理遷移衝突？
   • 在 settings.py 中啟用衝突檢測功能。
2. 如何批量執行多個應用的遷移？
   • 使用 migrate_all 命令或通過 API 批量調用。
3. 如何查看遷移歷史？
   • 使用 show_migrations 命令或查詢日誌文件。

🔧 技術細節

本項目基於 Django 框架開發，利用其強大的數據庫遷移功能和 Web 開發能力。通過 HTTP 接口和命令行工具，實現了對數據庫遷移的統一管理。同時，藉助 Redis 實現高效的狀態跟蹤，通過日誌系統記錄詳細的操作信息，確保系統的穩定性和可維護性。

🤝 貢獻指南

歡迎社區貢獻代碼和文檔！請 Fork 倉庫並在 Pull Request 中註明你的修改內容。

📄 許可證

本項目遵循 MIT 協議。