Instalar mssql-django

O mssql-django pacote é o backend oficial da base de dados Django suportada pela Microsoft para SQL Server, Base de Dados SQL do Azure, Azure SQL Managed Instance e base de dados SQL no Microsoft Fabric. Este artigo explica como instalar o pacote e as suas dependências.

Pré-requisitos

  • Python 3.8 ou posterior. O Django 6.0 requer Python 3.12 e versões posteriores.
  • gestor de pacotes pip (incluído com Python 3.4 e versões posteriores)
  • Microsoft ODBC Driver 17 ou 18 para SQL Server. Veja Descarregar o Driver ODBC para SQL Server.

Importante

Ao contrário do mssql-python driver, mssql-django requer um driver ODBC externo. Instale o driver Microsoft ODBC para SQL Server antes de configurar o seu projeto Django.

Instalar a partir do PyPI

Instala o pacote usando pip. Este comando também instala automaticamente o Django, pyodbc e pytz:

pip install mssql-django

Para atualizar uma instalação existente:

pip install --upgrade mssql-django

Para instalar uma versão específica:

pip install mssql-django==1.7.3

Compatibilidade de dependências e versões

Para mssql-django a 1.7.3, os metadados do pacote incluem estas restrições de dependência:

Componente Orientações sobre versões
Python 3.8 Ou versões posteriores
Django >=3.2 e <6.1
pyodbc >=3.0
pytz Instalado como uma dependência

Sugestão

Deixa pip resolver versões compatíveis, a menos que tenhas um ficheiro de bloqueio testado. Bloquear uma versão anterior pyodbc pode causar problemas durante a execução, mesmo que a instalação seja bem-sucedida.

Verifique a instalação

Após a instalação, verifique se o pacote está instalado corretamente:

pip show mssql-django

Produção esperada:

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

Verifique a instalação a partir de Python testando a camada ODBC:

import pyodbc

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

Note

O mssql-django backend é configurado automaticamente no sistema de encaminhamento de bases de dados da Django. Não importe diretamente no código da aplicação. Em vez disso, defina o ENGINE como mssql na sua DATABASES configuração.

Use um ambiente virtual

Use um ambiente virtual Python para isolar dependências de projetos:

python -m venv .venv

Ative o ambiente virtual:

.venv\Scripts\activate

Depois instala mssql-django dentro do ambiente virtual:

pip install mssql-django

Notas específicas da plataforma

Os passos de instalação dos drivers ODBC variam consoante o sistema operativo.

Windows

Instale o Microsoft ODBC Driver 18 for SQL Server utilizando o programa de instalação .msi disponível em Download ODBC Driver for SQL Server.

Linux

Instale o driver ODBC usando o gestor de pacotes da sua distribuição. Consulte Instalar o driver Microsoft ODBC para SQL Server (Linux) para instruções específicas da plataforma.

macOS

Instale o driver ODBC com Homebrew:

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

Dependencies

O mssql-django pacote instala automaticamente as seguintes dependências:

Package Purpose
Django Estrutura Web
pyodbc Driver de base de dados ODBC para Python
pytz Suporte para fusos horários

pytz continua a ser uma dependência de pacote por motivos de compatibilidade, mas a maioria dos fluxos de trabalho modernos de fusos horários no Django utiliza USE_TZ=True com o sistema integrado de fusos horários do Django.