19/04/2020 django-pyodbc-azure · PyPI

Search projects 

Help Sponsor Log in Register

django-pyodbc-azure  Latest version

2.1.0.0 Released: Aug 21, 2018

pip install django-pyodbc-azure 

Django backend for Microso SQL Server and Azure SQL Database using pyodbc

Navigation Project description

 Project
pypi v2.1.0.0 license BSD
description
django-pyodbc-azure is a modern fork of django-pyodbc, a Django
 Release Microso SQL Server external DB backend that uses ODBC by
history employing the pyodbc library. It supports Microso SQL Server and
Azure SQL Database.
 Download
files
Features

Supports Django 2.1

Project links Supports Microso SQL Server 2008/2008R2, 2012, 2014, 2016,
2017 and Azure SQL Database
 Homepage Passes most of the tests of the Django test suite
Compatible with Micoso ODBC Driver for SQL Server, SQL
Server Native Client, and FreeTDS ODBC drivers
Statistics

GitHub statistics:
Dependencies
 Stars: 316
https://pypi.org/project/django-pyodbc-azure/ 1/7
19/04/2020 django-pyodbc-azure · PyPI

 Forks: 141 Django 2.1

pyodbc 3.0 or newer
 Open
issues/PRs: 105
View statistics for this Installation
project via
Libraries.io , or by 1. Install pyodbc and Django
using our public 2. Install django-pyodbc-azure
dataset on Google
BigQuery 
pip install django-pyodbc-azure

Meta 3. Now you can point the ENGINE setting in the settings file used
by your Django application or project to the
License: BSD License
'sql_server.pyodbc' module path
(BSD)

Author: Michiya
Takahashi  'ENGINE': 'sql_server.pyodbc'

 azure, django

Configuration
Maintainers
Standard Django settings
michiya

The following entries in a database-level settings dictionary in

DATABASES control the behavior of the backend:
Classifiers
ENGINE
Development Status
4 - Beta String. It must be "sql_server.pyodbc" .
NAME
Framework
Django String. Database name. Required.
License HOST
OSI Approved ::
BSD License String. SQL Server instance in "server\instance" (on-
premise) or "server.database.windows.net" (Azure SQL
Programming Database) format.
Language
PORT
Python
Python :: 3 String. Server instance port. An empty string means the default
Python :: 3.5 port.
Python :: 3.6
USER
Python :: 3.7

https://pypi.org/project/django-pyodbc-azure/ 2/7
19/04/2020 django-pyodbc-azure · PyPI

Topic String. Database user name in "user" (on-premise) or

Internet :: "user@server" (Azure SQL Database) format. If not given then
WWW/HTTP 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 o icial 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 o icial
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

https://pypi.org/project/django-pyodbc-azure/ 3/7
19/04/2020 django-pyodbc-azure · PyPI

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 o .

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.

https://pypi.org/project/django-pyodbc-azure/ 4/7
19/04/2020 django-pyodbc-azure · PyPI

connection_retries

Integer. Sets the times to retry the database connection process.

Default value is 5 .
connection_retry_backo _time

Integer. Sets the back o 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 co

DATABASE_CONNECTION_POOLING = False

https://pypi.org/project/django-pyodbc-azure/ 5/7
19/04/2020 django-pyodbc-azure · PyPI

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"

Help About PyPI

Installing packages  PyPI on Twitter 

Uploading packages  Infrastructure dashboard 
User guide  Package index name retention 
FAQs Our sponsors

Contributing to PyPI Using PyPI

Bugs and feedback Code of conduct 

Contribute on GitHub  Report security issue
Translate PyPI  Privacy policy 
Development credits  Terms of use

Status: All Systems Operational 

https://pypi.org/project/django-pyodbc-azure/ 6/7
19/04/2020 django-pyodbc-azure · PyPI

Developed and maintained by the Python community, for the Python community.
Donate today!

© 2020 Python So ware Foundation 

Site map

Switch to desktop version

 English español français ⽇本語 Português Brasileiro Українська Ελληνικά Deutsch 简体中文
Русский

Google
Pingdom Object Storage and Sentry AWS DataDog
Monitoring Download Analytics Error logging Cloud computing Monitoring

Fastly DigiCert StatusPage

CDN EV certificate Status page

https://pypi.org/project/django-pyodbc-azure/ 7/7