mssql-python をインストールする

mssql-pythonドライバーは、Microsoft Microsoft FabricのSQL Server、Azure SQL Database、Azure SQL Managed Instance、SQLデータベースの公式Pythonドライバーです。 Windows、Linux、macOSでpipを使ってドライバーをインストールしてください。

前提条件

  • このドライバーはPython 3.10以降が必要で、以前のPythonバージョンはサポートしていません。
  • PIPパッケージマネージャー(Python 3.4+に付属)。

Important

mssql-pythonドライバは DDBC (Direct Database Connectivity)を使用しており、ODBC層を内部でバンドル・管理しています。 SQL ServerのMicrosoft ODBCドライバーを別途インストールする必要はありません。

PyPI からインストールする

PIPを使ってドライバーをインストールする:

pip install mssql-python

既存のインストールをアップグレードするには:

pip install --upgrade mssql-python

特定のバージョンをインストールするには、以下を実行します。

pip install mssql-python==1.11.0

インストールを確認する

取り付け後、ドライバーが動作しているか確認してください:

import mssql_python

print(f"mssql-python version: {mssql_python.__version__}")
print(f"DB-API level: {mssql_python.apilevel}")
print(f"Thread safety: {mssql_python.threadsafety}")
print(f"Parameter style: {mssql_python.paramstyle}")

予想される出力:

mssql-python version: 1.11.0
DB-API level: 2.0
Thread safety: 1
Parameter style: pyformat

プラットフォーム固有の注意事項

Windows

このドライバーは、必要なコンポーネントをすべて含むビルド済みホイールとして提供されます。

Linux

このドライバはKerberos認証および動的読み込みのために特定のシステムライブラリを必要とします。 ディストリビューションのパッケージマネージャーを使ってインストールしてください:

Ubuntu/Debian:

sudo apt-get update
sudo apt-get install libltdl7 libkrb5-3 libgssapi-krb5-2

Red Hat/CentOS/Fedora:

sudo dnf install libtool-ltdl krb5-libs

Note

RHEL 8および他のglibc 2.28互換ディストリビューション(AlmaLinux 8、Rocky Linux 8)では、ドライバーはPyPIに公開された標準の manylinux_2_28 ホイールからインストールされます。

Alpine Linux:

apk add libltdl krb5-libs

macOS

ドライバーは universal2 ファットバイナリとして出荷され、Apple Silicon(arm64)とIntel(x86_64)Macの両方でネイティブに動作します。 別途UnixODBCをインストールする必要はありません。

ドライバーはOpenSSLが必要です。 Homebrewを使ってインストールする方法:

brew install openssl

SSL関連のエラーが発生した場合は、OpenSSLが正しくリンクされていることを確認してください:

export LDFLAGS="-L/opt/homebrew/opt/openssl/lib"
export CPPFLAGS="-I/opt/homebrew/opt/openssl/include"

仮想環境

競合を避けるために、Pythonパッケージは仮想環境にインストールしてください:

# Create a virtual environment
python -m venv .venv

# Activate it (Windows)
.venv\Scripts\activate

# Activate it (Linux/macOS)
source .venv/bin/activate

# Install the driver
pip install mssql-python

開発用インストール

開発依存関係でドライバーをインストールし、ドライバーに貢献するには:

git clone https://github.com/microsoft/mssql-python.git
cd mssql-python
pip install -e ".[dev]"

インストールの問題をトラブルシューティングする

PIPのインストールが「マッチングディストリビューションなし」で失敗します

Python 3.10以降を使用していることを確認してください:

python --version

古いPythonバージョンを使っているなら、Pythonをアップグレードするか、pyenvを使って複数のバージョンを管理してください。

インストール後のインポートエラー

もし見つけたら、パッケージをインストールしたPython環境と同じModuleNotFoundError: No module named 'mssql_python'を使っているか確認してください。

pip show mssql-python

Linux/macOSでの権限エラー

権限エラーが発生した場合は、 sudo pipの使用を避けてください。 代わりに、仮想環境や --user フラグを使いましょう。

pip install --user mssql-python