mssql-django konfigurationsreferenz

Dieser Artikel ist die vollständige settings.py Konfigurationsreferenz für das mssql-django Django-Datenbank-Backend. Konfigurieren Sie die SQL Server-Konnektivität, indem Sie das DATABASES Wörterbuch in der settings.py Datei Ihres Django-Projekts bearbeiten.

Minimale Konfiguration

Das folgende Beispiel zeigt die minimal erforderliche Konfiguration für den Standardpfad pyodbc :

DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 18 for SQL Server",
        },
    },
}

Um stattdessen den Alias auszuführen mssql-python , python_driver setze und lass driver. Der Weg mssql-python ignoriert driver:

DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<database>",
        "USER": "<user_id>",
        "PASSWORD": "<password>",
        "HOST": "<server>",
        "PORT": "1433",
        "OPTIONS": {
            "python_driver": "mssql_python",
        },
    },
}

ENGINE "mssql" bleibt auf beiden Pfaden. Aliase im selben Projekt können unterschiedliche Treiber verwenden. Für die vollständige Liste der Verhaltensunterschiede siehe Select the database driver for mssql-django.

Sofern nicht anders angegeben, zeigen die Beispiele im restlichen Teil dieses Artikels den Standardpfad pyodbc .

Datenbank-Verbindungseinstellungen

Diese Einstellungen konfigurieren deine DATABASES Verbindung. Die meisten sind Standard-Django-Einstellungen; Ausnahmen werden vermerkt:

TEST-Einstellungen

Diese Einstellungen steuern die Testdatenbank, die von Djangos Testrunner verwendet wird:

Beispiel:

DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 18 for SQL Server",
        },
        "TEST": {
            "NAME": "test_mydb",
            "COLLATION": "SQL_Latin1_General_CP1_CI_AS",
        },
    },
}

OPTIONEN

Das Wörterbuch OPTIONS bietet backend-spezifische Konfigurationen. Fügen Sie diese Einstellungen ins Wörterbuch DATABASES["default"]["OPTIONS"] ein:

Beispiel mit gängigen Optionen:

DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>.database.windows.net",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 18 for SQL Server",
            "extra_params": "Encrypt=yes",
            "isolation_level": "READ COMMITTED",
            "connection_timeout": 30,
            "connection_retries": 3,
            "connection_retry_backoff_time": 5,
            "query_timeout": 60,
        },
    },
}

Backend-spezifische Einstellungen

Diese Einstellung wird auf Modulebene in settings.py, außerhalb des Wörterbuchs DATABASES , platziert:

Beispiel:

DATABASES = {
    "default": {
        "ENGINE": "mssql",
        "NAME": "<your-database>",
        "USER": "<your-username>",
        "PASSWORD": "<your-password>",
        "HOST": "<your-server>",
        "PORT": "1433",
        "OPTIONS": {
            "driver": "ODBC Driver 18 for SQL Server",
        },
    },
}

# Set this to False to disable driver-level connection pooling
DATABASE_CONNECTION_POOLING = False

Verwandte Inhalte

• Verbindungsoptionen für mssql-django
• Wählen Sie den Datenbanktreiber für mssql-django aus
• Microsoft Entra-Authentifizierung mit mssql-django
• Verbindungspooling in mssql-django
• Django-Datenbankeinstellungen