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.10 a 3.14. O Django 6.0 e versões posteriores exigem pelo menos Python 3.12.
  • gestor de pacotes pip (incluído com Python 3.4 e versões posteriores)
  • Microsoft ODBC Driver 17 ou 18 para SQL Server, para alias de base de dados que usam o driver padrãopyodbc. Veja Descarregar o Driver ODBC para SQL Server.

Importante

mssql-django 2.0 requer mssql-python versão 1.15.0 ou posterior, mesmo quando todos os aliases de base de dados usam pyodbc. O pacote instala-se apenas em plataformas que tenham uma distribuição compatível mssql-python . Os projetos noutras plataformas mantêm-se na versão 1.8.0. Para a lista de plataformas, consulte o suporte e o ciclo de vida do mssql-django.

Instalar a partir do PyPI

Instala o pacote usando pip. Este comando também instala Django, pyodbc, mssql-python, e tzdata 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==2.0.0

Compatibilidade de dependências e versões

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

Componente Orientações sobre versões
Python 3.10 a 3.14
Django >=5.2 e <6.2
pyodbc >=3.0
mssql-python >=1.15.0
tzdata 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.

Escolha um controlador de base de dados

pyodbc é o driver padrão e não precisa de configuração. Para executar, em vez disso, um alias de base de dados em mssql-python, adicione "python_driver": "mssql_python" ao dicionário OPTIONS desse alias. Os aliases podem usar drivers diferentes no mesmo projeto. Para as diferenças de comportamento e as opções que cada driver ignora, veja Selecionar o driver da base de dados para mssql-django.

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: 2.0.0
Summary: Django backend for Microsoft SQL Server

Verifique a camada ODBC que o caminho padrão pyodbc utiliza:

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 alias de base de dados que utilizam o driver predefinido pyodbc precisam de um driver ODBC instalado separadamente, e os passos de instalação variam consoante o sistema operativo. Os alias que usam mssql-python não precisam destes passos. Em vez disso, instale os pré-requisitos da plataforma para mssql-python, incluindo OpenSSL no macOS e as bibliotecas obrigatórias no Linux.

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 Controlador ODBC de base de dados predefinido para Python
mssql-python Controlador de base de dados Python opcional, instalado incondicionalmente
tzdata Base de dados de fusos horários IANA para o módulo padrão da biblioteca zoneinfo

O backend converte valores datetime com reconhecimento de fuso horário utilizando o módulo zoneinfo da biblioteca padrão. zoneinfo lê a base de dados de fusos horários IANA do sistema operativo quando esta existe e, caso contrário, recorre ao pacote tzdata, que abrange o Windows e imagens mínimas de contentores. pytz já não é uma dependência.

Conteúdo relacionado

  • Last updated on