Installer mssql-django

Le package mssql-django est le backend de base de données Django officiel pris en charge par Microsoft pour SQL Server, Azure SQL Database, Azure SQL Managed Instance et la base de données SQL de Microsoft Fabric. Cet article explique comment installer le package et ses dépendances.

Prerequisites

  • Python 3.10 à 3.14. Django 6.0 et les versions ultérieures nécessitent au moins Python 3.12.
  • gestionnaire de package pip (inclus avec Python 3.4 et versions ultérieures)
  • Microsoft ODBC Driver 17 ou 18 pour SQL Server, pour les alias de base de données utilisant le pilote par défautpyodbc. Consultez Télécharger le pilote ODBC pour SQL Server.

Important

mssql-django La version 2.0 nécessite mssql-python la version 1.15.0 ou ultérieure, même lorsque chaque alias de base de données utilise pyodbc. Le package s’installe uniquement sur des plateformes ayant une distribution compatible mssql-python . Les projets sur d’autres plateformes restent sur la version 1.8.0. Pour la liste des plateformes, voir le support et le cycle de vie de mssql-django.

Installer à partir de PyPI

Installez le package en utilisant pip. Cette commande installe également Django, pyodbc, mssql-python, et tzdata automatiquement :

pip install mssql-django

Pour mettre à niveau une installation existante :

pip install --upgrade mssql-django

Pour installer une version spécifique :

pip install mssql-django==2.0.0

Compatibilité des dépendances et des versions

Pour la mssql-django version 2.0, les métadonnées du paquet incluent ces contraintes de dépendance :

Composant Recommandations de version
Python 3.10 à 3.14
Django >=5.2 et <6.2
pyodbc >=3.0
mssql-python >=1.15.0
tzdata Installé en tant que dépendance

Tip

Laissez pip résoudre des versions compatibles, sauf si vous disposez d’un fichier de verrouillage testé. L'épinglage d'une ancienne version de pyodbc peut provoquer des problèmes de runtime même si l'installation réussit.

Choisissez un pilote de base de données

pyodbc est le pilote par défaut et ne nécessite aucune configuration. Pour exécuter à la place un alias de base de données sur mssql-python, ajoutez "python_driver": "mssql_python" au dictionnaire OPTIONS de cet alias. Les alias peuvent utiliser différents pilotes dans un même projet. Pour les différences de comportement et les options que chaque pilote ignore, voir Sélectionner le pilote de base de données pour mssql-django.

Vérifier l’installation

Après l’installation, vérifiez que le package est installé correctement :

pip show mssql-django

Sortie attendue :

Name: mssql-django
Version: 2.0.0
Summary: Django backend for Microsoft SQL Server

Vérifiez la couche ODBC utilisée par le chemin par défaut pyodbc :

import pyodbc

print(f"pyodbc version: {pyodbc.version}")
print(f"Available ODBC drivers: {pyodbc.drivers()}")

Note

Le mssql-django serveur principal est automatiquement configuré dans le système de routage de base de données de Django. Ne l’importez pas directement dans le code de l’application. À la place, définissez ENGINE sur mssql dans la configuration DATABASES.

Utiliser un environnement virtuel

Utilisez un environnement virtuel Python pour isoler les dépendances de projet :

python -m venv .venv

Activez l’environnement virtuel :

.venv\Scripts\activate

Installez mssql-django ensuite à l’intérieur de l’environnement virtuel :

pip install mssql-django

Notes spécifiques à la plateforme

Les alias de base de données utilisant le pilote par défaut pyodbc nécessitent un pilote ODBC installé séparément, et les étapes d’installation varient selon le système d’exploitation. Les alias qui utilisent mssql-python n’ont pas besoin de ces étapes. Installez plutôt les prérequis de la plateforme mssql-python, y compris OpenSSL sur macOS et les bibliothèques requises sous Linux.

Windows

Installez Microsoft ODBC Driver 18 for SQL Server à l’aide du programme d’installation .msi disponible sur Téléchargement du pilote ODBC pour SQL Server.

Linux

Installez le pilote ODBC à l’aide du gestionnaire de package de votre distribution. Consultez Installer le pilote ODBC Microsoft pour SQL Server (Linux) pour obtenir des instructions spécifiques à la plateforme.

macOS

Installez le pilote ODBC avec Homebrew :

brew tap microsoft/mssql-release https://github.com/Microsoft/homebrew-mssql-release
brew update
HOMEBREW_ACCEPT_EULA=Y brew install msodbcsql18

Dependencies

Le mssql-django package installe automatiquement les dépendances suivantes :

Package Purpose
Django Framework web
pyodbc Pilote de base de données ODBC par défaut pour Python
mssql-python Pilote Python de base de données optionnel, installé systématiquement
tzdata Base de données de fuseaux horaires IANA pour le module de bibliothèque zoneinfo standard

Le backend convertit les valeurs datetime associées à un fuseau horaire en utilisant le module zoneinfo de la bibliothèque standard. zoneinfo lit la base de données IANA des fuseaux horaires du système d’exploitation lorsqu’elle est présente et utilise sinon le paquet tzdata, qui prend en charge Windows et les images de conteneur minimales. pytz ce n’est plus une dépendance.