django-mssql-backend から mssql-django に移行する

この記事では、Django プロジェクトを (django-mssql-backend エンジンを使用した) sql_server.pyodbc パッケージから mssql-django パッケージに移行する方法について説明します。

Overview

mssql-django パッケージは、django-mssql-backendの後継です。 pyodbc を使用するSQL Server用の Django データベース バックエンドが引き続き提供されますが、パッケージ名、エンジン識別子、および新しい Django バージョンのサポートが更新されています。

手順 1: Python パッケージを更新する

古いパッケージをアンインストールし、新しいパッケージをインストールします。

pip uninstall django-mssql-backend
pip install mssql-django

requirements.txt ファイルを使用する場合は、パッケージ参照を置き換えます。

# Before
django-mssql-backend>=2.8.1

# After
mssql-django>=1.7

手順 2: DATABASE エンジンを更新する

settings.pyで、ENGINEの値を sql_server.pyodbc から mssql に変更します。

# Before
DATABASES = {
    "default": {
        "ENGINE": "sql_server.pyodbc",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 17 for SQL Server",
        },
    },
}

# After
DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 18 for SQL Server",
        },
    },
}

手順 3: INSTALLED_APPSを更新する

INSTALLED_APPSがsql_serverを参照している場合は、更新します。

# Before
INSTALLED_APPS = [
    "sql_server",
    # ...
]

# After - only needed if using inspectdb
INSTALLED_APPS = [
    "mssql",
    # ...
]

手順 4: 構成を確認する

クイック検証を実行して、新しいバックエンドが正常に接続されていることを確認します。

python manage.py check
python manage.py showmigrations

手順 5: テスト スイートを実行する

プロジェクトのテスト スイートを実行して、すべてが新しいバックエンドで動作することを確認します。

python manage.py test

注意が必要な破壊的変更

関連するコンテンツ

• mssql-django をインストールする
• mssql-django の新機能
• mssql-django 構成リファレンス