Instal mssql-django

Paket mssql-django adalah backend basis data Django resmi yang didukung Microsoft untuk SQL Server, Azure SQL Database, Azure SQL Managed Instance, dan basis data SQL di Microsoft Fabric. Artikel ini menjelaskan cara menginstal paket dan dependensinya.

Prasyarat

  • Python 3.10 hingga 3.14. Django 6.0 dan versi yang lebih baru membutuhkan setidaknya Python 3.12.
  • manajer paket pip (disertakan dengan Python 3.4 dan versi yang lebih baru)
  • Microsoft ODBC Driver 17 atau 18 untuk SQL Server, untuk alias database yang menggunakan driver defaultpyodbc. Lihat Mengunduh Driver ODBC untuk SQL Server.

Important

mssql-django 2.0 membutuhkan mssql-python versi 1.15.0 atau lebih baru, bahkan ketika setiap alias database menggunakan pyodbc. Paket ini hanya dapat diinstal pada platform yang memiliki distribusi yang kompatibel mssql-python . Proyek di platform lain tetap berada di versi 1.8.0. Untuk daftar platform, lihat dukungan dan siklus hidup mssql-django.

Menginstal dari PyPI

Instal paket menggunakan pip. Perintah ini juga menginstal Django, pyodbc, mssql-python, dan tzdata secara otomatis:

pip install mssql-django

Untuk meningkatkan penginstalan yang ada:

pip install --upgrade mssql-django

Untuk memasang versi tertentu:

pip install mssql-django==2.0.0

Dependensi dan kompatibilitas versi

Untuk mssql-django versi 2.0, metadata paket mencakup batasan ketergantungan berikut:

Komponen Panduan Versi
Python 3.10 hingga 3.14
Django >=5.2 dan <6.2
pyodbc >=3.0
mssql-python >=1.15.0
tzdata Diinstal sebagai dependensi

Tip

Biarkan pip menentukan versi yang kompatibel kecuali Anda memiliki berkas lock yang sudah teruji. Menyematkan versi lama pyodbc dapat menyebabkan masalah runtime bahkan ketika penginstalan berhasil.

Pilih driver database

pyodbc adalah driver default dan tidak memerlukan konfigurasi. Untuk menjalankan alias basis data pada mssql-python sebagai gantinya, tambahkan "python_driver": "mssql_python" ke kamus OPTIONS milik alias tersebut. Alias dapat menggunakan driver yang berbeda di proyek yang sama. Untuk perbedaan perilaku dan opsi yang diabaikan oleh setiap driver, lihat Pilih driver database untuk mssql-django.

Memverifikasi penginstalan

Setelah penginstalan, verifikasi bahwa paket diinstal dengan benar:

pip show mssql-django

Output yang diharapkan:

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

Verifikasi lapisan ODBC yang digunakan oleh jalur default pyodbc :

import pyodbc

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

Note

Backend mssql-django tersebut secara otomatis dikonfigurasi di sistem perutean basis data Django. Jangan mengimpornya langsung dalam kode aplikasi. Sebagai gantinya, atur ENGINE ke mssql dalam konfigurasi DATABASES Anda.

Menggunakan lingkungan virtual

Gunakan lingkungan virtual Python untuk mengisolasi dependensi proyek:

python -m venv .venv

Aktifkan lingkungan virtual:

.venv\Scripts\activate

Kemudian instal mssql-django di dalam lingkungan virtual:

pip install mssql-django

Catatan khusus platform

Alias database yang menggunakan driver default pyodbc memerlukan driver ODBC yang terpasang secara terpisah, dan langkah instalasi berbeda-beda tergantung sistem operasi. Alias yang menggunakan mssql-python tidak memerlukan langkah-langkah ini. Sebagai gantinya, instal prasyarat platform untuk mssql-python, termasuk OpenSSL di macOS dan pustaka yang diperlukan di Linux.

Windows

Instal Microsoft ODBC Driver 18 untuk SQL Server menggunakan .msi penginstal dari Unduh Driver ODBC untuk SQL Server.

Linux

Instal driver ODBC menggunakan manajer paket distribusi Anda. Lihat Menginstal driver ODBC Microsoft untuk SQL Server (Linux) untuk instruksi khusus platform.

macOS

Instal driver ODBC dengan Homebrew:

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

Ketergantungan

Paket mssql-django secara otomatis menginstal dependensi berikut:

Package Kegunaan
Django Kerangka kerja web
pyodbc Driver database ODBC bawaan untuk Python
mssql-python Driver database Python yang bisa diaktifkan, diinstal tanpa syarat
tzdata Basis data zona waktu IANA untuk modul perpustakaan zoneinfo standar

Backend mengonversi nilai datetime yang mendukung zona waktu dengan menggunakan modul zoneinfo dari pustaka standar. zoneinfo membaca basis data zona waktu IANA milik sistem operasi jika tersedia dan menggunakan paket tzdata sebagai cadangan jika tidak, yang mencakup Windows dan image kontainer minimal. pytz bukan lagi ketergantungan.