Instalar mssql-django

O mssql-django pacote é o back-end oficial do banco de dados Django com suporte Microsoft para SQL Server, Banco de Dados SQL do Azure, Instância Gerenciada de SQL do Azure e banco de dados SQL no Microsoft Fabric. Este artigo explica como instalar o pacote e suas dependências.

Pré-requisitos

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

Importante

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

Instalar via PyPI

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

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

Dependência e compatibilidade de versão

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

Componente Diretrizes de versão
Python 3.8 ou versões posteriores
Django >=3.2 e <6.1
pyodbc >=3.0
pytz Instalado como uma dependência

Tip

Deixe pip resolver versões compatíveis, a menos que você tenha um arquivo de bloqueio testado. Fixar uma versão anterior pyodbc pode causar problemas em tempo de execução, mesmo que a instalação seja bem-sucedida.

Verificar a instalação

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

pip show mssql-django

Resultado esperado:

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

Verifique a instalação 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 roteamento de bancos de dados do Django. Não importe diretamente no código do aplicativo. Em vez disso, defina o ENGINE para mssql em sua DATABASES configuração.

Usar um ambiente virtual

Use um ambiente virtual Python para isolar as dependências do projeto:

python -m venv .venv

Ative o ambiente virtual:

.venv\Scripts\activate

Em seguida, instale mssql-django dentro do ambiente virtual:

pip install mssql-django

Notas específicas da plataforma

As etapas de instalação do driver ODBC variam de acordo com o sistema operacional.

Windows

Instale o Microsoft ODBC Driver 18 para SQL Server usando o instalador .msi disponível em Baixar o Driver ODBC para SQL Server.

Linux

Instale o driver ODBC usando o gerenciador de pacotes da distribuição. Consulte Instalar o driver ODBC Microsoft para SQL Server (Linux) para obter 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 da Web
pyodbc Driver de banco de dados ODBC para Python
pytz Suporte a fuso horário

pytz permanece uma dependência de pacote para compatibilidade, mas a maioria dos fluxos de trabalho de fuso horário modernos do Django usam USE_TZ=True com o tratamento de fuso horário interno do Django.