Merge pull request #16 from microsoft/dev

Prepare for 1.0b1 release

Author: absci

README.md

@@ -16,7 +16,7 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
 -  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
+   and [FreeTDS](https://www.freetds.org/) ODBC drivers
 
 ## Dependencies
 
@@ -27,14 +27,14 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
 
 1. Install pyodbc 3.0 (or newer) and Django 2.2 (or 3.0)
 
-2. Install mssql-django ::
+2. Install mssql-django:
 
-    pip 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'``
+3. Set the `ENGINE` setting in the `settings.py` file used by
+   your Django application or project to `'mssql'`:
 
-    ``'ENGINE': 'mssql'``
+       'ENGINE': 'mssql'
 
 ## Configuration
 
@@ -45,15 +45,15 @@ in DATABASES control the behavior of the backend:
 
 -  ENGINE
 
-   String. It must be ``"mssql"``.
+   String. It must be `"mssql"`.
 
 -  NAME
 
    String. Database name. Required.
 
 -  HOST
 
-   String. SQL Server instance in ``"server\instance"`` format.
+   String. SQL Server instance in `"server\instance"` format.
 
 -  PORT
 
@@ -62,7 +62,7 @@ in DATABASES control the behavior of the backend:
 
 -  USER
 
-   String. Database user name in ``"user"`` format.
+   String. Database user name in `"user"` format.
    If not given then MS Integrated Security will be used.
 
 -  PASSWORD
@@ -71,22 +71,22 @@ in DATABASES control the behavior of the backend:
 
 -  AUTOCOMMIT
 
-   Boolean. Set this to False if you want to disable
+   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
+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``.
+   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
+   If the default value (`None`) is used, the test database is assigned
    the default collation of the instance of SQL Server.
 
 -  DEPENDENCIES
@@ -97,7 +97,7 @@ for any given database-level settings dictionary:
 -  MIRROR
 
    String. The alias of the database that this database should
-   mirror during testing. Default value is ``None``.
+   mirror during testing. Default value is `None`.
    See the official Django documentation for more details.
 
 ### OPTIONS
@@ -106,22 +106,22 @@ 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"``.
+   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
+   `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``.
+   String. A named DSN can be used instead of `HOST`.
 
 -  host_is_server
 
@@ -192,7 +192,7 @@ The following project-level settings also control the behavior of the backend:
 
 Here is an example of the database settings:
 
-```
+```python
     DATABASES = {
         'default': {
             'ENGINE': 'mssql',
@@ -211,6 +211,7 @@ Here is an example of the database settings:
     # 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:
@@ -238,7 +239,7 @@ contact [[email protected]](mailto:[email protected]) with any additio
 
 ## Security Reporting Instructions
 
-For security reporting instructions please refer to the SECURITY.md file in this repository.
+For security reporting instructions please refer to the [`SECURITY.md`](SECURITY.md) file in this repository.
 
 ## Trademarks
 

azure-pipelines.yml

@@ -6,7 +6,7 @@ variables:
   agent.preferPowerShellOnContainers: true
 
 schedules:
-- cron: "0 0 * * *"
+- cron: "0 9 * * *"
   displayName: Daily midnight build
   branches:
     include:
@@ -20,12 +20,26 @@ jobs:
 
     strategy:
       matrix:
+        Python 3.8 - Django 3.1:
+          python.version: '3.8'
+          tox.env: 'py38-django31'
+        Python 3.7 - Django 3.1:
+          python.version: '3.7'
+          tox.env: 'py37-django31'
+        Python 3.6 - Django 3.1:
+          python.version: '3.6'
+          tox.env: 'py36-django31'
+
+        Python 3.8 - Django 3.0:
+          python.version: '3.8'
+          tox.env: 'py38-django30'
         Python 3.7 - Django 3.0:
           python.version: '3.7'
           tox.env: 'py37-django30'
         Python 3.6 - Django 3.0:
           python.version: '3.6'
           tox.env: 'py36-django30'
+
         Python 3.7 - Django 2.2:
           python.version: '3.7'
           tox.env: 'py37-django22'
@@ -62,12 +76,26 @@ jobs:
 
     strategy:
       matrix:
+        Python 3.8 - Django 3.1:
+          python.version: '3.8'
+          tox.env: 'py38-django31'
+        Python 3.7 - Django 3.1:
+          python.version: '3.7'
+          tox.env: 'py37-django31'
+        Python 3.6 - Django 3.1:
+          python.version: '3.6'
+          tox.env: 'py36-django31'
+
+        Python 3.8 - Django 3.0:
+          python.version: '3.8'
+          tox.env: 'py38-django30'
         Python 3.7 - Django 3.0:
           python.version: '3.7'
           tox.env: 'py37-django30'
         Python 3.6 - Django 3.0:
           python.version: '3.6'
           tox.env: 'py36-django30'
+
         Python 3.7 - Django 2.2:
           python.version: '3.7'
           tox.env: 'py37-django22'
@@ -87,7 +115,7 @@ jobs:
           curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
           curl https://packages.microsoft.com/config/ubuntu/18.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list
           sudo apt-get update
-          sudo ACCEPT_EULA=Y apt-get install -y msodbcsql17 g++ unixodbc-dev
+          sudo ACCEPT_EULA=Y apt-get install -y msodbcsql17 g++ unixodbc-dev libmemcached-dev
         displayName: Install SQL Server
 
       - script: |

mssql/creation.py

@@ -5,10 +5,17 @@
 import os
 
 from django.db.backends.base.creation import BaseDatabaseCreation
+from django import VERSION as django_version
 
 
 class DatabaseCreation(BaseDatabaseCreation):
 
+    def cursor(self):
+        if django_version >= (3, 1):
+            return self.connection._nodb_cursor()
+
+        return self.connection._nodb_connection.cursor()
+
     def _destroy_test_db(self, test_database_name, verbosity):
         """
         Internal implementation - remove the test db tables.
@@ -17,7 +24,7 @@ def _destroy_test_db(self, test_database_name, verbosity):
         # ourselves. Connect to the previous database (not the test database)
         # to do so, because it's not allowed to delete a database while being
         # connected to it.
-        with self.connection._nodb_connection.cursor() as cursor:
+        with self.cursor() as cursor:
             to_azure_sql_db = self.connection.to_azure_sql_db
             if not to_azure_sql_db:
                 cursor.execute("ALTER DATABASE %s SET SINGLE_USER WITH ROLLBACK IMMEDIATE"
@@ -39,7 +46,7 @@ def enable_clr(self):
         This function will not fail if current user doesn't have
         permissions to enable clr, and clr is already enabled
         """
-        with self._nodb_connection.cursor() as cursor:
+        with self.cursor() as cursor:
             # check whether clr is enabled
             cursor.execute('''
             SELECT value FROM sys.configurations
@@ -89,7 +96,7 @@ def install_regex_clr(self, database_name):
 
         self.enable_clr()
 
-        with self._nodb_connection.cursor() as cursor:
+        with self.self.cursor() as cursor:
             for s in sql:
                 cursor.execute(s)
 

mssql/features.py

@@ -24,8 +24,10 @@ class DatabaseFeatures(BaseDatabaseFeatures):
     requires_literal_defaults = True
     requires_sqlparse_for_splitting = False
     supports_boolean_expr_in_select_clause = False
+    supports_deferrable_unique_constraints = False
     supports_ignore_conflicts = False
     supports_index_on_text_field = False
+    supports_json_field = False
     supports_paramstyle_pyformat = False
     supports_regex_backreferencing = True
     supports_sequence_reset = False

mssql/functions.py

@@ -6,7 +6,7 @@
 from django.db.models.functions import Cast
 from django.db.models.functions.math import ATan2, Log, Ln, Mod, Round
 from django.db.models.expressions import Case, Exists, OrderBy, When
-from django.db.models.lookups import Lookup
+from django.db.models.lookups import Lookup, In
 
 DJANGO3 = VERSION[0] >= 3
 
@@ -91,11 +91,29 @@ def sqlserver_orderby(self, compiler, connection):
     return self.as_sql(compiler, connection, template=template)
 
 
+def split_parameter_list_as_sql(self, compiler, connection):
+    # Insert In clause parameters 1000 at a time into a temp table.
+    lhs, _ = self.process_lhs(compiler, connection)
+    _, rhs_params = self.batch_process_rhs(compiler, connection)
+
+    with connection.cursor() as cursor:
+        cursor.execute("IF OBJECT_ID('tempdb.dbo.#Temp_params', 'U') IS NOT NULL DROP TABLE #Temp_params; ")
+        cursor.execute("CREATE TABLE #Temp_params (params nvarchar(32))")
+        for offset in range(0, len(rhs_params), 1000):
+            sqls_params = rhs_params[offset: offset + 1000]
+            sqls_params = ", ".join("('{}')".format(item) for item in sqls_params)
+            cursor.execute("INSERT INTO #Temp_params VALUES %s" % sqls_params)
+
+    in_clause = lhs + ' IN ' + '(SELECT params from #Temp_params)'
+
+    return in_clause, ()
+
 ATan2.as_microsoft = sqlserver_atan2
 Log.as_microsoft = sqlserver_log
 Ln.as_microsoft = sqlserver_ln
 Mod.as_microsoft = sqlserver_mod
 Round.as_microsoft = sqlserver_round
+In.split_parameter_list_as_sql = split_parameter_list_as_sql
 
 if DJANGO3:
     Lookup.as_microsoft = sqlserver_lookup