Metadata-Version: 1.1
Name: django-pyodbc-azure
Version: 1.0.5
Summary: Django backends for MS SQL Server and Windows Azure SQL Database using pyodbc
Home-page: https://github.com/michiya/django-pyodbc-azure
Author: Michiya Takahashi
Author-email: UNKNOWN
License: BSD
Description: django-pyodbc-azure
        ===================
        
        *django-pyodbc-azure* is a refined fork of
        `django-pyodbc <https://github.com/avidal/django-pyodbc>`__, a
        `Django <http://djangoproject.com/>`__ MS SQL Server external DB backend
        that uses ODBC by employing the
        `pyodbc <https://code.google.com/p/pyodbc/>`__ library. It supports MS
        SQL Server and Windows Azure SQL Database.
        
        Features
        --------
        
        -  Supports Django 1.2, 1.3, 1.4, 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),
           *Micosoft ODBC Driver for SQL Server* and *FreeTDS* (Linux) ODBC drivers.
        
        Dependencies
        ------------
        
        -  Django 1.2 or newer
        -  pyodbc 2.1 or newer
        
        Installation
        ------------
        
        1. Install pyodbc
        
        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
        -------------
        
        The following database-level settings 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 ODBC driver to
           activate the autocommit feature. Default value is ``False``.
        
        -  MARS_Connection
        
           Boolean. Only relevant when using Microsoft's SQL Server drivers
           (SQL Server Native Client or ODBC Driver for SQL Server).
           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://www.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``
           (the same behavior as the original ``django-pyodbc``). Otherwise, they
           are mapped to new dedicated data types (``date``, ``time``, ``datetime2``).
           Default value is ``False``, and note that the feature is always activated
           when you use SQL Server 2005 or FreeTDS.
        
        ``django-pyodbc-azure``-specific settings
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        The following project-level settings also control the behavior of the backend:
        
        -  DATABASE_CONNECTION_POOLING
        
           Boolean. Indicates if pyodbc should activate its connection pooling feature.
           Default value is ``True``.
        
        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': 'SQL Server Native Client 11.0',
                        'MARS_Connection': True,
                    },
                },
            }
            
            # set this to False if you want to turn off pyodbc's connection pooling
            DATABASE_CONNECTION_POOLING = False
        
        Limitation
        ----------
        
        You can work with Windows Azure SQL Database only with Microsoft's
        new SQL Server drivers (SQL Server Native Client on Windows,
        or ODBC Driver for SQL Server on Linux).
        For now FreeTDS doesn't support the new version of TDS protocol
        that is required to interact with Windows Azure SQL Database.
        
        License
        =======
        
        New BSD LICENSE
        
        Credits
        =======
        
        -  `Ramiro Morales <https://people.djangoproject.com/ramiro/>`__
        -  `Filip Wasilewski <http://code.djangoproject.com/ticket/5246>`__
        -  `Wei guangjing <https://people.djangoproject.com/vcc/>`__
        -  `mamcx <http://code.djangoproject.com/ticket/5062>`__
        -  `Alex Vidal <http://github.com/avidal/>`__
        -  `Michiya Takahashi <http://github.com/michiya/>`__
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Framework :: Django
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.4
Classifier: Programming Language :: Python :: 2.5
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Internet :: WWW/HTTP
