mssql-django パッケージは、Microsoft FabricのSQL Server、Azure SQL Database、Azure SQL Managed Instance、および SQL データベース用の公式のMicrosoftサポートされている Django データベース バックエンドです。 この記事では、パッケージとその依存関係をインストールする方法について説明します。
前提条件
- Python 3.8 以降。 Django 6.0 には、Python 3.12 以降のバージョンが必要です。
- pip パッケージ マネージャー (Python 3.4 以降のバージョンに含まれています)
- Microsoft ODBC Driver 17 または 18 for SQL Server 「ODBC Driver for SQL Server のダウンロード」を参照してください。
Important
mssql-python ドライバーとは異なり、mssql-djangoには外部 ODBC ドライバーが必要です。 Django プロジェクトを構成する前に、Microsoft ODBC Driver for SQL Serverをインストールします。
PyPI からインストールする
pip を使用してパッケージをインストールします。 このコマンドでは、Django、pyodbc、pytz も自動的にインストールされます。
pip install mssql-django
既存のインストールをアップグレードするには:
pip install --upgrade mssql-django
特定のバージョンをインストールするには、以下を実行します。
pip install mssql-django==1.7.3
依存関係とバージョンの互換性
mssql-django 1.7.3 の場合、パッケージ メタデータには次の依存関係の制約が含まれます。
| コンポーネント | バージョンに関するガイダンス |
|---|---|
| Python | 3.8 以降のバージョン |
| Django |
>=3.2 および <6.1 |
| pyodbc | >=3.0 |
| pytz | 依存関係としてインストール済み |
Tip
テスト済みのロック ファイルがない限り、 pip 互換性のあるバージョンを解決します。 古い pyodbc バージョンをピン留めすると、インストールが成功した場合でもランタイムの問題が発生する可能性があります。
インストールを確認する
インストール後、パッケージが正しくインストールされていることを確認します。
pip show mssql-django
予想される出力:
Name: mssql-django
Version: 1.7.3
Summary: Django backend for Microsoft SQL Server
ODBC レイヤーをテストして、Pythonからのインストールを確認します。
import pyodbc
print(f"pyodbc version: {pyodbc.version}")
print(f"Available ODBC drivers: {pyodbc.drivers()}")
Note
mssql-django バックエンドは、Django のデータベース ルーティング システムで自動的に構成されます。 アプリケーション コードで直接インポートしないでください。 代わりに、DATABASES 構成で ENGINE を mssql に設定します。
仮想環境を使用する
Python仮想環境を使用して、プロジェクトの依存関係を分離します。
python -m venv .venv
仮想環境をアクティブ化します。
.venv\Scripts\activate
次に、仮想環境内に mssql-django をインストールします。
pip install mssql-django
プラットフォーム固有の注意事項
ODBC ドライバーのインストール手順は、オペレーティング システムによって異なります。
Windows
Microsoft ODBC Driver 18 for SQL Serverをインストールする場合は、「.msi SQL Server のダウンロード」の インストーラーを使用します。
リナックス
ディストリビューションのパッケージ マネージャーを使用して ODBC ドライバーをインストールします。 プラットフォーム固有の手順については、「SQL Server (Linux) 用Microsoft ODBC ドライバーをインストールする」を参照してください。
macOS
Homebrew を使用して ODBC ドライバーをインストールします。
brew tap microsoft/mssql-release https://github.com/Microsoft/homebrew-mssql-release
brew update
HOMEBREW_ACCEPT_EULA=Y brew install msodbcsql18
依存関係
mssql-django パッケージは、次の依存関係を自動的にインストールします。
| Package | Purpose |
|---|---|
Django |
Web フレームワーク |
pyodbc |
Python用 ODBC データベース ドライバー |
pytz |
タイム ゾーンのサポート |
pytz は互換性のためにパッケージの依存関係のままですが、最新の Django タイム ゾーン ワークフローでは、Django の組み込みのタイム ゾーン処理で USE_TZ=True が使用されます。