Skip to main content

Django backend for Microsoft SQL Server

Project description


Welcome to the MSSQL-Django 3rd party backend project!

mssql-django is a fork of django-mssql-backend. This project provides an enterprise database connectivity option for the Django Web Framework, with support for Microsoft SQL Server and Azure SQL Database.

We'd like to give thanks to the community that made this project possible, with particular recognition of the contributors: OskarPersson, michiya, dlo and the original Google Code django-pyodbc team. Moving forward we encourage partipation in this project from both old and new contributors!

We hope you enjoy using the MSSQL-Django 3rd party backend.



  • Django 2.2 or 3.0
  • pyodbc 3.0 or newer


  1. Install pyodbc 3.0 (or newer) and Django 2.2 (or 3.0)

  2. Install mssql-django:

    pip install mssql-django
  3. Set the ENGINE setting in the file used by your Django application or project to 'mssql':

    'ENGINE': 'mssql'


Standard Django settings

The following entries in a database-level settings dictionary in DATABASES control the behavior of the backend:


    String. It must be "mssql".

  • NAME

    String. Database name. Required.

  • HOST

    String. SQL Server instance in "server\instance" format.

  • PORT

    String. Server instance port. An empty string means the default port.

  • USER

    String. Database user name in "user" format. If not given then MS Integrated Security will be used.


    String. Database user password.


    Boolean. Set this to False if you want to disable Django's transaction management and implement your own.

and the following entries are also available in the TEST dictionary for any given database-level settings dictionary:

  • NAME

    String. The name of database to use when running the test suite. If the default value (None) is used, the test database will use the name "test\_" + NAME.


    String. The collation order to use when creating the test database. If the default value (None) is used, the test database is assigned the default collation of the instance of SQL Server.


    String. The creation-order dependencies of the database. See the official Django documentation for more details.


    String. The alias of the database that this database should mirror during testing. Default value is None. See the official Django documentation for more details.


Dictionary. Current available keys are:

  • driver

    String. ODBC Driver to use ("ODBC Driver 17 for SQL Server", "SQL Server Native Client 11.0", "FreeTDS" etc). Default is "ODBC Driver 17 for SQL Server".

  • isolation_level

    String. Sets transaction isolation level for each database session. Valid values for this entry are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ, SNAPSHOT, and SERIALIZABLE. Default is None which means no isolation levei is set to a database session and SQL Server default will be used.

  • dsn

    String. A named DSN can be used instead of HOST.

  • host_is_server

    Boolean. Only relevant if using the FreeTDS ODBC driver under Unix/Linux.

    By default, when using the FreeTDS ODBC driver the value specified in the HOST setting is used in a SERVERNAME ODBC connection string component instead of being used in a SERVER component; this means that this value should be the name of a dataserver definition present in the freetds.conf FreeTDS configuration file instead of a hostname or an IP address.

    But if this option is present and it's value is True, this special behavior is turned off.

    See for more information.

  • unicode_results

    Boolean. If it is set to True, pyodbc's unicode_results feature is activated and strings returned from pyodbc are always Unicode. Default value is False.

  • extra_params

    String. Additional parameters for the ODBC connection. The format is "param=value;param=value".

  • collation

    String. Name of the collation to use when performing text field lookups against the database. Default is None; this means no collation specifier is added to your lookup SQL (the default collation of your database will be used). For Chinese language you can set it to "Chinese_PRC_CI_AS".

  • connection_timeout

    Integer. Sets the timeout in seconds for the database connection process. Default value is 0 which disables the timeout.

  • connection_retries

    Integer. Sets the times to retry the database connection process. Default value is 5.

  • connection_retry_backoff_time

    Integer. Sets the back off time in seconds for reries of the database connection process. Default value is 5.

  • query_timeout

    Integer. Sets the timeout in seconds for the database query. Default value is 0 which disables the timeout.

Backend-specific settings

The following project-level settings also control the behavior of the backend:


    Boolean. If it is set to False, pyodbc's connection pooling feature won't be activated.


Here is an example of the database settings:

        'default': {
            'ENGINE': 'mssql',
            'NAME': 'mydb',
            'USER': 'user@myserver',
            'PASSWORD': 'password',
            'HOST': '',
            'PORT': '',

            'OPTIONS': {
                'driver': 'ODBC Driver 17 for SQL Server',

    # set this to False if you want to turn off pyodbc's connection pooling


The following features are currently not supported:

  • mssql-django does not support SQL-based regex commands
  • Altering a model field from or to AutoField at migration

Future Plans

The following features and additions are planned:

  • install instructions for CLR .dll file to add SQL-based regex command support to SQL Server or Azure SQL DB


This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact with any additional questions or comments.

Security Reporting Instructions

For security reporting instructions please refer to the file in this repository.


This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mssql-django-1.0b1.tar.gz (49.0 kB view hashes)

Uploaded Source

Built Distribution

mssql_django-1.0b1-py3-none-any.whl (58.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page