django-pyodbc-azure
===================
.. image:: http://img.shields.io/pypi/v/django-pyodbc-azure.svg?style=flat
:target: https://pypi.python.org/pypi/django-pyodbc-azure
.. image:: http://img.shields.io/pypi/l/django-pyodbc-azure.svg?style=flat
:target: http://opensource.org/licenses/BSD-3-Clause
*django-pyodbc-azure* is a modern fork of
`django-pyodbc <https://code.google.com/archive/p/django-pyodbc/>`__, a
`Django <https://www.djangoproject.com/>`__ Microsoft SQL Server external
DB backend that uses ODBC by employing the
`pyodbc <https://github.com/mkleehammer/pyodbc>`__ library. It supports
Microsoft SQL Server and Azure SQL Database.
Features
--------
- Supports Django 2.1
- Supports Microsoft SQL Server 2008/2008R2, 2012, 2014, 2016, 2017 and
Azure SQL Database
- 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 <http://www.freetds.org/>`__ ODBC drivers
Dependencies
------------
- Django 2.1
- pyodbc 3.0 or newer
Installation
------------
1. Install pyodbc and Django
2. Install django-pyodbc-azure ::
pip install django-pyodbc-azure
3. Now you can point the ``ENGINE`` setting in the settings file used by
your Django application or project to the ``'sql_server.pyodbc'``
module path ::
'ENGINE': 'sql_server.pyodbc'
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 ``"sql_server.pyodbc"``.
- NAME
String. Database name. Required.
- HOST
String. SQL Server instance in ``"server\instance"`` (on-premise) or
``"server.database.windows.net"`` (Azure SQL Database) format.
- PORT
String. Server instance port.
An empty string means the default port.
- USER
String. Database user name in ``"user"`` (on-premise) or
``"user@server"`` (Azure SQL Database) format.
If not given then MS Integrated Security will be used.
- PASSWORD
String. Database user password.
- AUTOCOMMIT
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``.
- 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 13 for SQL Server"``,
``"SQL Server Native Client 11.0"``, ``"FreeTDS"`` etc).
Default is ``"ODBC Driver 13 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 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 http://www.freetds.org/userguide/dsnless.htm 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:
- 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:
::
DATABASES = {
'default': {
'ENGINE': 'sql_server.pyodbc',
'NAME': 'mydb',
'USER': 'user@myserver',
'PASSWORD': 'password',
'HOST': 'myserver.database.windows.net',
'PORT': '',
'OPTIONS': {
'driver': 'ODBC Driver 13 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 supported:
- Altering a model field from or to AutoField at migration
Notice
------
This version of *django-pyodbc-azure* only supports Django 2.1.
If you want to use it on older versions of Django,
specify an appropriate version number (2.0.x.x for Django 2.0)
at installation like this: ::
pip install "django-pyodbc-azure<2.1"
Raw data
{
"_id": null,
"home_page": "https://github.com/michiya/django-pyodbc-azure",
"name": "django-pyodbc-azure",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "azure django",
"author": "Michiya Takahashi",
"author_email": "michiya.takahashi@gmail.com",
"download_url": "",
"platform": "",
"description": "django-pyodbc-azure\n===================\n\n.. image:: http://img.shields.io/pypi/v/django-pyodbc-azure.svg?style=flat\n :target: https://pypi.python.org/pypi/django-pyodbc-azure\n\n.. image:: http://img.shields.io/pypi/l/django-pyodbc-azure.svg?style=flat\n :target: http://opensource.org/licenses/BSD-3-Clause\n\n*django-pyodbc-azure* is a modern fork of\n`django-pyodbc <https://code.google.com/archive/p/django-pyodbc/>`__, a\n`Django <https://www.djangoproject.com/>`__ Microsoft SQL Server external\nDB backend that uses ODBC by employing the\n`pyodbc <https://github.com/mkleehammer/pyodbc>`__ library. It supports\nMicrosoft SQL Server and Azure SQL Database.\n\nFeatures\n--------\n\n- Supports Django 2.1\n- Supports Microsoft SQL Server 2008/2008R2, 2012, 2014, 2016, 2017 and\n Azure SQL Database\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 <http://www.freetds.org/>`__ ODBC drivers\n\nDependencies\n------------\n\n- Django 2.1\n- pyodbc 3.0 or newer\n\nInstallation\n------------\n\n1. Install pyodbc and Django\n\n2. Install django-pyodbc-azure ::\n\n pip install django-pyodbc-azure\n\n3. Now you can point the ``ENGINE`` setting in the settings file used by\n your Django application or project to the ``'sql_server.pyodbc'``\n module path ::\n\n 'ENGINE': 'sql_server.pyodbc'\n\nConfiguration\n-------------\n\nStandard Django settings\n~~~~~~~~~~~~~~~~~~~~~~~~\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 ``\"sql_server.pyodbc\"``.\n\n- NAME\n\n String. Database name. Required.\n\n- HOST\n\n String. SQL Server instance in ``\"server\\instance\"`` (on-premise) or\n ``\"server.database.windows.net\"`` (Azure SQL Database) 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\"`` (on-premise) or\n ``\"user@server\"`` (Azure SQL Database) format.\n If not given then MS Integrated Security will be used.\n\n- PASSWORD\n\n String. Database user password.\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\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\nOPTIONS\n~~~~~~~\n\nDictionary. Current available keys are:\n\n- driver\n\n String. ODBC Driver to use (``\"ODBC Driver 13 for SQL Server\"``,\n ``\"SQL Server Native Client 11.0\"``, ``\"FreeTDS\"`` etc).\n Default is ``\"ODBC Driver 13 for SQL Server\"``.\n\n- isolation_level\n\n String. Sets `transaction isolation level\n <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 levei 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 it's value is ``True``, this\n special behavior is turned off.\n\n See http://www.freetds.org/userguide/dsnless.htm 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\"``.\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\nbackend-specific settings\n~~~~~~~~~~~~~~~~~~~~~~~~~\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\nExample\n~~~~~~~\n\nHere is an example of the database settings:\n\n::\n\n DATABASES = {\n 'default': {\n 'ENGINE': 'sql_server.pyodbc',\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 13 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\nLimitations\n-----------\n\nThe following features are currently not supported:\n\n- Altering a model field from or to AutoField at migration\n\nNotice\n------\n\nThis version of *django-pyodbc-azure* only supports Django 2.1.\nIf you want to use it on older versions of Django,\nspecify an appropriate version number (2.0.x.x for Django 2.0)\nat installation like this: ::\n\n pip install \"django-pyodbc-azure<2.1\"\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "Django backend for Microsoft SQL Server and Azure SQL Database using pyodbc",
"version": "2.1.0.0",
"project_urls": {
"Homepage": "https://github.com/michiya/django-pyodbc-azure"
},
"split_keywords": [
"azure",
"django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18ab133c68bbea94839d8f3b8b4aea4f70e1c6b8ac929aba4adbadc458566a76",
"md5": "4bfdee7ad4a8fd99377a235867d563f9",
"sha256": "1fa3b31f4432ef2c90c434b284ad093478f8221121dafef05fafbe2c4d872211"
},
"downloads": -1,
"filename": "django_pyodbc_azure-2.1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bfdee7ad4a8fd99377a235867d563f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 39653,
"upload_time": "2018-08-21T00:40:17",
"upload_time_iso_8601": "2018-08-21T00:40:17.998189Z",
"url": "https://files.pythonhosted.org/packages/18/ab/133c68bbea94839d8f3b8b4aea4f70e1c6b8ac929aba4adbadc458566a76/django_pyodbc_azure-2.1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2018-08-21 00:40:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "michiya",
"github_project": "django-pyodbc-azure",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "django-pyodbc-azure"
}
JSON
