# Microsoft Django backend for SQL Server
Welcome to the MSSQL-Django 3rd party backend project!
*mssql-django* is a fork of [django-mssql-backend](https://pypi.org/project/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.
## Features
- Supports Django 3.2, 4.0, 4.1, 4.2 and 5.0
- Tested on Microsoft SQL Server 2016, 2017, 2019, 2022
- Passes most of the tests of the Django test suite
- Compatible with
[Micosoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server),
[SQL Server Native Client](https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx),
and [FreeTDS](https://www.freetds.org/) ODBC drivers
## Dependencies
- pyodbc 3.0 or newer
## Installation
1. Install pyodbc 3.0 (or newer) and Django
2. Install mssql-django:
pip install mssql-django
3. Set the `ENGINE` setting in the `settings.py` file used by
your Django application or project to `'mssql'`:
'ENGINE': 'mssql'
## Configuration
### Standard Django settings
The following entries in a database-level settings dictionary
in DATABASES control the behavior of the backend:
- ENGINE
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.
- PASSWORD
String. Database user password.
- TOKEN
String. Access token fetched as a user or service principal which
has access to the database. E.g. when using `azure.identity`, the
result of `DefaultAzureCredential().get_token('https://database.windows.net/.default')`
can be passed.
- AUTOCOMMIT
Boolean. Set this to `False` if you want to disable
Django's transaction management and implement your own.
- Trusted_Connection
String. Default is `"yes"`. Can be set to `"no"` if required.
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`.
- COLLATION
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.
- DEPENDENCIES
String. The creation-order dependencies of the database.
See the official Django documentation for more details.
- MIRROR
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.
### OPTIONS
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](https://docs.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql)
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 level 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 its value is ``True``, this
special behavior is turned off. Instead, connections to the database
server will be established using ``HOST`` and ``PORT`` options, without
requiring ``freetds.conf`` to be configured.
See https://www.freetds.org/userguide/dsnless.html 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"``, [Azure AD Authentication](https://github.com/microsoft/mssql-django/wiki/Azure-AD-Authentication) (Service Principal, Interactive, Msi) can be added to this field.
- 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.
- [setencoding](https://github.com/mkleehammer/pyodbc/wiki/Connection#setencoding) and [setdecoding](https://github.com/mkleehammer/pyodbc/wiki/Connection#setdecoding)
```python
# Example
"OPTIONS": {
"setdecoding": [
{"sqltype": pyodbc.SQL_CHAR, "encoding": 'utf-8'},
{"sqltype": pyodbc.SQL_WCHAR, "encoding": 'utf-8'}],
"setencoding": [
{"encoding": "utf-8"}],
...
},
```
- return_rows_bulk_insert
Boolean. Sets if backend can return rows from bulk insert.
Default value is False which doesn't allows for the backend to
return rows from bulk insert. Must be set to False if database
has tables with triggers to prevent errors when inserting.
```python
# Examples
"OPTIONS": {
# This database doesn't have any triggers so can use return
# rows from bulk insert feature
"return_rows_bulk_insert": True
}
"OPTIONS": {
# This database has triggers so leave return_rows_bulk_insert as blank (False)
# to prevent errors related to inserting and returning rows from bulk insert
}
```
### Backend-specific settings
The following project-level settings also control the behavior of the backend:
- DATABASE_CONNECTION_POOLING
Boolean. If it is set to ``False``, pyodbc's connection pooling feature
won't be activated.
### Example
Here is an example of the database settings:
```python
DATABASES = {
'default': {
'ENGINE': 'mssql',
'NAME': 'mydb',
'USER': 'user@myserver',
'PASSWORD': 'password',
'HOST': 'myserver.database.windows.net',
'PORT': '',
'OPTIONS': {
'driver': 'ODBC Driver 17 for SQL Server',
},
},
}
# set this to False if you want to turn off pyodbc's connection pooling
DATABASE_CONNECTION_POOLING = False
```
## Limitations
The following features are currently not fully supported:
- Altering a model field from or to AutoField at migration
- Django annotate functions have floating point arithmetic problems in some cases
- Annotate function with exists
- Exists function in order_by
- Righthand power and arithmetic with datatimes
- Timezones, timedeltas not fully supported
- Rename field/model with foreign key constraint
- Database level constraints
- Filtered index
- Date extract function
- Bulk insert into a table with a trigger and returning the rows inserted
JSONField lookups have limitations, more details [here](https://github.com/microsoft/mssql-django/wiki/JSONField).
## Contributing
More details on contributing can be found [here](CONTRIBUTING.md).
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 https://cla.opensource.microsoft.com.
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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
## Security Reporting Instructions
For security reporting instructions please refer to the [`SECURITY.md`](SECURITY.md) file in this repository.
## Trademarks
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](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/microsoft/mssql-django",
"name": "mssql-django",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "django",
"author": "Microsoft",
"author_email": "opencode@microsoft.com",
"download_url": "https://files.pythonhosted.org/packages/25/00/05350c21b76c0852b88846f153455dedb86410c548f272e0dbf382abc86a/mssql-django-1.4.2.tar.gz",
"platform": null,
"description": "# Microsoft Django backend for SQL Server\n\nWelcome to the MSSQL-Django 3rd party backend project!\n\n*mssql-django* is a fork of [django-mssql-backend](https://pypi.org/project/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.\n\nWe'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!\n\nWe hope you enjoy using the MSSQL-Django 3rd party backend.\n\n## Features\n\n- Supports Django 3.2, 4.0, 4.1, 4.2 and 5.0\n- Tested on Microsoft SQL Server 2016, 2017, 2019, 2022\n- Passes most of the tests of the Django test suite\n- Compatible with\n [Micosoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server),\n [SQL Server Native Client](https://msdn.microsoft.com/en-us/library/ms131321(v=sql.120).aspx),\n and [FreeTDS](https://www.freetds.org/) ODBC drivers\n\n## Dependencies\n\n- pyodbc 3.0 or newer\n\n## Installation\n\n1. Install pyodbc 3.0 (or newer) and Django\n2. Install mssql-django:\n\n pip install mssql-django\n\n3. Set the `ENGINE` setting in the `settings.py` file used by\n your Django application or project to `'mssql'`:\n\n 'ENGINE': 'mssql'\n\n## Configuration\n\n### Standard Django settings\n\nThe following entries in a database-level settings dictionary\nin DATABASES control the behavior of the backend:\n\n- ENGINE\n\n String. It must be `\"mssql\"`.\n\n- NAME\n\n String. Database name. Required.\n\n- HOST\n\n String. SQL Server instance in `\"server\\instance\"` format.\n\n- PORT\n\n String. Server instance port.\n An empty string means the default port.\n\n- USER\n\n String. Database user name in `\"user\"` format.\n If not given then MS Integrated Security will be used.\n\n- PASSWORD\n\n String. Database user password.\n\n- TOKEN\n\n String. Access token fetched as a user or service principal which\n has access to the database. E.g. when using `azure.identity`, the\n result of `DefaultAzureCredential().get_token('https://database.windows.net/.default')`\n can be passed.\n\n- AUTOCOMMIT\n\n Boolean. Set this to `False` if you want to disable\n Django's transaction management and implement your own.\n\n- Trusted_Connection\n\n String. Default is `\"yes\"`. Can be set to `\"no\"` if required.\n\nand the following entries are also available in the `TEST` dictionary\nfor any given database-level settings dictionary:\n\n- NAME\n\n String. The name of database to use when running the test suite.\n If the default value (`None`) is used, the test database will use\n the name `\"test_\" + NAME`.\n\n- COLLATION\n\n String. The collation order to use when creating the test database.\n If the default value (`None`) is used, the test database is assigned\n the default collation of the instance of SQL Server.\n\n- DEPENDENCIES\n\n String. The creation-order dependencies of the database.\n See the official Django documentation for more details.\n\n- MIRROR\n\n String. The alias of the database that this database should\n mirror during testing. Default value is `None`.\n See the official Django documentation for more details.\n\n### OPTIONS\n\nDictionary. Current available keys are:\n\n- driver\n\n String. ODBC Driver to use (`\"ODBC Driver 17 for SQL Server\"`,\n `\"SQL Server Native Client 11.0\"`, `\"FreeTDS\"` etc).\n Default is `\"ODBC Driver 17 for SQL Server\"`.\n\n- isolation_level\n\n String. Sets [transaction isolation level](https://docs.microsoft.com/en-us/sql/t-sql/statements/set-transaction-isolation-level-transact-sql)\n for each database session. Valid values for this entry are\n `READ UNCOMMITTED`, `READ COMMITTED`, `REPEATABLE READ`,\n `SNAPSHOT`, and `SERIALIZABLE`. Default is `None` which means\n no isolation level is set to a database session and SQL Server default\n will be used.\n\n- dsn\n\n String. A named DSN can be used instead of `HOST`.\n\n- host_is_server\n\n Boolean. Only relevant if using the FreeTDS ODBC driver under\n Unix/Linux.\n\n By default, when using the FreeTDS ODBC driver the value specified in\n the ``HOST`` setting is used in a ``SERVERNAME`` ODBC connection\n string component instead of being used in a ``SERVER`` component;\n this means that this value should be the name of a *dataserver*\n definition present in the ``freetds.conf`` FreeTDS configuration file\n instead of a hostname or an IP address.\n\n But if this option is present and its value is ``True``, this\n special behavior is turned off. Instead, connections to the database\n server will be established using ``HOST`` and ``PORT`` options, without\n requiring ``freetds.conf`` to be configured.\n\n See https://www.freetds.org/userguide/dsnless.html for more information.\n\n- unicode_results\n\n Boolean. If it is set to ``True``, pyodbc's *unicode_results* feature\n is activated and strings returned from pyodbc are always Unicode.\n Default value is ``False``.\n\n- extra_params\n\n String. Additional parameters for the ODBC connection. The format is\n ``\"param=value;param=value\"``, [Azure AD Authentication](https://github.com/microsoft/mssql-django/wiki/Azure-AD-Authentication) (Service Principal, Interactive, Msi) can be added to this field.\n\n- collation\n\n String. Name of the collation to use when performing text field\n lookups against the database. Default is ``None``; this means no\n collation specifier is added to your lookup SQL (the default\n collation of your database will be used). For Chinese language you\n can set it to ``\"Chinese_PRC_CI_AS\"``.\n\n- connection_timeout\n\n Integer. Sets the timeout in seconds for the database connection process.\n Default value is ``0`` which disables the timeout.\n\n- connection_retries\n\n Integer. Sets the times to retry the database connection process.\n Default value is ``5``.\n\n- connection_retry_backoff_time\n\n Integer. Sets the back off time in seconds for reries of\n the database connection process. Default value is ``5``.\n\n- query_timeout\n\n Integer. Sets the timeout in seconds for the database query.\n Default value is ``0`` which disables the timeout.\n\n- [setencoding](https://github.com/mkleehammer/pyodbc/wiki/Connection#setencoding) and [setdecoding](https://github.com/mkleehammer/pyodbc/wiki/Connection#setdecoding)\n\n ```python\n # Example\n \"OPTIONS\": {\n \"setdecoding\": [\n {\"sqltype\": pyodbc.SQL_CHAR, \"encoding\": 'utf-8'},\n {\"sqltype\": pyodbc.SQL_WCHAR, \"encoding\": 'utf-8'}],\n \"setencoding\": [\n {\"encoding\": \"utf-8\"}],\n ...\n },\n ```\n\n- return_rows_bulk_insert\n\n Boolean. Sets if backend can return rows from bulk insert.\n Default value is False which doesn't allows for the backend to\n return rows from bulk insert. Must be set to False if database\n has tables with triggers to prevent errors when inserting.\n\n ```python\n # Examples\n \"OPTIONS\": {\n # This database doesn't have any triggers so can use return\n # rows from bulk insert feature\n \"return_rows_bulk_insert\": True\n }\n\n \"OPTIONS\": {\n # This database has triggers so leave return_rows_bulk_insert as blank (False)\n # to prevent errors related to inserting and returning rows from bulk insert\n }\n ```\n\n### Backend-specific settings\n\nThe following project-level settings also control the behavior of the backend:\n\n- DATABASE_CONNECTION_POOLING\n\n Boolean. If it is set to ``False``, pyodbc's connection pooling feature\n won't be activated.\n\n### Example\n\nHere is an example of the database settings:\n\n```python\n DATABASES = {\n 'default': {\n 'ENGINE': 'mssql',\n 'NAME': 'mydb',\n 'USER': 'user@myserver',\n 'PASSWORD': 'password',\n 'HOST': 'myserver.database.windows.net',\n 'PORT': '',\n\n 'OPTIONS': {\n 'driver': 'ODBC Driver 17 for SQL Server',\n },\n },\n }\n\n # set this to False if you want to turn off pyodbc's connection pooling\n DATABASE_CONNECTION_POOLING = False\n```\n\n## Limitations\n\nThe following features are currently not fully supported:\n- Altering a model field from or to AutoField at migration\n- Django annotate functions have floating point arithmetic problems in some cases\n- Annotate function with exists\n- Exists function in order_by\n- Righthand power and arithmetic with datatimes\n- Timezones, timedeltas not fully supported\n- Rename field/model with foreign key constraint\n- Database level constraints\n- Filtered index\n- Date extract function\n- Bulk insert into a table with a trigger and returning the rows inserted\n\nJSONField lookups have limitations, more details [here](https://github.com/microsoft/mssql-django/wiki/JSONField).\n\n## Contributing\n\nMore details on contributing can be found [here](CONTRIBUTING.md).\n\nThis project welcomes contributions and suggestions. Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.\n\nWhen you submit a pull request, a CLA bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Security Reporting Instructions\n\nFor security reporting instructions please refer to the [`SECURITY.md`](SECURITY.md) file in this repository.\n\n## Trademarks\n\nThis project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft\ntrademarks or logos is subject to and must follow\n[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).\nUse of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.\nAny use of third-party trademarks or logos are subject to those third-party's policies.\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Django backend for Microsoft SQL Server",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/microsoft/mssql-django",
"Release Notes": "https://github.com/microsoft/mssql-django/releases"
},
"split_keywords": [
"django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d875f0aac33faa7438cc32e8b8b6cce5eab8ded36a63464257e7ca98b840cee3",
"md5": "f43dacd4b8a6d0bed5ef72f60f947897",
"sha256": "a9934f3fc9a507a7ac5be21ad02109ba5352e56bf17959de7f29bbc5ad97e762"
},
"downloads": -1,
"filename": "mssql_django-1.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f43dacd4b8a6d0bed5ef72f60f947897",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 100345,
"upload_time": "2024-03-14T23:41:38",
"upload_time_iso_8601": "2024-03-14T23:41:38.054760Z",
"url": "https://files.pythonhosted.org/packages/d8/75/f0aac33faa7438cc32e8b8b6cce5eab8ded36a63464257e7ca98b840cee3/mssql_django-1.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "250005350c21b76c0852b88846f153455dedb86410c548f272e0dbf382abc86a",
"md5": "8842b8057ac0787409726a240fd03a83",
"sha256": "430b7e19eaec1396c9ab32abb4d3378fec375fb23bf93f61140fdcaaa7052d6c"
},
"downloads": -1,
"filename": "mssql-django-1.4.2.tar.gz",
"has_sig": false,
"md5_digest": "8842b8057ac0787409726a240fd03a83",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 81964,
"upload_time": "2024-03-14T23:41:39",
"upload_time_iso_8601": "2024-03-14T23:41:39.943634Z",
"url": "https://files.pythonhosted.org/packages/25/00/05350c21b76c0852b88846f153455dedb86410c548f272e0dbf382abc86a/mssql-django-1.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-14 23:41:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "microsoft",
"github_project": "mssql-django",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mssql-django"
}
JSON
