Django backends for MS SQL Server and Windows Azure SQL Database using pyodbc
Project description
django-pyodbc-azure
django-pyodbc-azure is a refined fork of django-pyodbc, a Django MS SQL Server external DB backend that uses ODBC by employing the pyodbc library. It supports MS SQL Server and Windows Azure SQL Database.
Features
Supports Django 1.2, 1.3, 1.4, and 1.5
Supports MS SQL Server 2005, 2008/2008R2, 2012, and Windows Azure SQL Database
Supports LIMIT+OFFSET and offset w/o LIMIT emulation.
Passes most of the tests of the Django test suite.
Compatible with SQL Server and SQL Server Native Client (Windows), Microsoft ODBC Driver for SQL Server and FreeTDS ODBC drivers (Linux).
Dependencies
Django 1.2 or newer
pyodbc 2.1 or newer
Installation
Install pyodbc
Install django-pyodbc-azure
pip install django-pyodbc-azure
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
The following settings in DATABASES['alias'] control the behavior of the backend:
Standard Django settings
ENGINE
String. It must be "sql_server.pyodbc".
DATABASE_NAME
String. Database name. Required.
HOST
String. SQL Server instance in "server\instance" (on-premise) or "server.database.windows.net" (Windows Azure SQL Database) format.
PORT
String. Server instance port.
USER
String. Database user name in "user" (on-premise) or "user@server" (Windows Azure SQL Database) format. If not given then MS Integrated Security will be used.
PASSWORD
String. Database user password.
OPTIONS
Dictionary. Current available keys are:
autocommit
Boolean. Indicates if pyodbc should direct the the ODBC driver to activate the autocommit feature. Default value is False.
MARS_Connection
Boolean. Only relevant when using MS SQL Server Native Client driver. Default value is False.
driver
String. ODBC Driver to use ("SQL Server Native Client 11.0" etc). See http://msdn.microsoft.com/en-us/library/ms130892.aspx. Default is "SQL Server" on Windows and "FreeTDS" on other platforms.
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://freetds.org/userguide/dsnless.htm for more information.
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".
use_legacy_datetime
Boolean. DateField, TimeField and DateTimeField of models are mapped to SQL Server’s legacy datetime type if the value is True (it’s the same behavior as the old django-pyodbc). Otherwise, they are mapped to new dedicated data types (date, time, datetime2). Default value is False.
Example
Here is an example of 'default' database settings:
DATABASES = { 'default': { 'ENGINE': 'sql_server.pyodbc', 'NAME': 'mydb', 'USER': 'user@myserver', 'PASSWORD': 'password', 'HOST': 'myserver.database.windows.net', 'PORT': '', 'OPTIONS': { 'driver': 'SQL Server Native Client 11.0', 'MARS_Connection': True, }, }, }
License
New BSD LICENSE
Credits
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for django-pyodbc-azure-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98eb63ba6088ccacd968b48af4cc455f58eb950b39400755b6b37d81ffb5df66 |
|
MD5 | e938b314e6e58b691e2799c0671862e8 |
|
BLAKE2b-256 | 60e94678b3d99befa65a316d3d6170889f985a1740fa5fa5b680bdd688b6715e |