Prepare for 1.4 release

Prepare for 1.4 release

Author: mShan0

CodeQL.yml

@@ -0,0 +1,3 @@
+path_classifiers:
+  library:
+    - "django"

README.md

@@ -10,7 +10,7 @@ We hope you enjoy using the MSSQL-Django 3rd party backend.
 
 ## Features
 
--  Supports Django 3.2, 4.0, 4.1 and 4.2
+-  Supports Django 3.2, 4.0, 4.1, 4.2 and 5.0
 -  Tested on Microsoft SQL Server 2016, 2017, 2019, 2022
 -  Passes most of the tests of the Django test suite
 -  Compatible with

azure-pipelines.yml

@@ -19,11 +19,21 @@ jobs:
     pool:
       name: Django-1ES-pool
       demands:
-      - imageOverride -equals JDBC-MMS2019-SQL2019
+      - imageOverride -equals JDBC-MMS2019-SQL2019-2
     timeoutInMinutes: 120
 
     strategy:
       matrix:
+        Python3.12 - Django 5.0:
+          python.version: '3.12'
+          tox.env: 'py312-django50'
+        Python3.11 - Django 5.0:
+          python.version: '3.11'
+          tox.env: 'py311-django50'
+        Python3.10 - Django 5.0:
+          python.version: '3.10'
+          tox.env: 'py310-django50'
+
         Python3.11 - Django 4.2:
           python.version: '3.11'
           tox.env: 'py311-django42'
@@ -78,7 +88,7 @@ jobs:
 
 
     steps:
-      - task: CredScan@2
+      - task: CredScan@3
         inputs:
           toolMajorVersion: 'V2'
 
@@ -92,7 +102,7 @@ jobs:
 
           (Get-Content $pwd/testapp/settings.py).replace('localhost', $IP) | Set-Content $pwd/testapp/settings.py
 
-          Invoke-WebRequest https://download.microsoft.com/download/E/6/B/E6BFDC7A-5BCD-4C51-9912-635646DA801E/en-US/17.5.2.1/x64/msodbcsql.msi -OutFile msodbcsql.msi
+          Invoke-WebRequest https://download.microsoft.com/download/6/f/f/6ffefc73-39ab-4cc0-bb7c-4093d64c2669/en-US/17.10.5.1/x64/msodbcsql.msi -OutFile msodbcsql.msi
           msiexec /quiet /passive /qn /i msodbcsql.msi IACCEPTMSODBCSQLLICENSETERMS=YES
           Get-OdbcDriver
         displayName: Install ODBC
@@ -126,11 +136,21 @@ jobs:
     pool:
       name: Django-1ES-pool
       demands:
-      - imageOverride -equals MMSUbuntu20.04
+      - imageOverride -equals Ubuntu22.04-AzurePipelines
     timeoutInMinutes: 120
 
     strategy:
       matrix:
+        Python3.12 - Django 5.0:
+          python.version: '3.12'
+          tox.env: 'py312-django50'
+        Python3.11 - Django 5.0:
+          python.version: '3.11'
+          tox.env: 'py311-django50'
+        Python3.10 - Django 5.0:
+          python.version: '3.10'
+          tox.env: 'py310-django50'
+
         Python3.11 - Django 4.2:
           python.version: '3.11'
           tox.env: 'py311-django42'
@@ -190,12 +210,11 @@ jobs:
         displayName: Use Python $(python.version)
 
       - script: |
+          docker version
           docker pull mcr.microsoft.com/mssql/server:2022-latest
           docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=$(TestAppPassword)' -p 1433:1433 -d mcr.microsoft.com/mssql/server:2022-latest
           curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
-          curl https://packages.microsoft.com/config/ubuntu/20.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 libmemcached-dev
+          curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list
         displayName: Install SQL Server
 
       - script: |

mssql/base.py

@@ -581,7 +581,7 @@ def format_sql(self, sql, params):
             sql = smart_str(sql, self.driver_charset)
 
         # pyodbc uses '?' instead of '%s' as parameter placeholder.
-        if params is not None:
+        if params is not None and params != []:
             sql = sql % tuple('?' * len(params))
 
         return sql

mssql/compiler.py

@@ -16,7 +16,7 @@
 if django.VERSION >= (3, 1):
     from django.db.models.fields.json import compile_json_path, KeyTransform as json_KeyTransform
 if django.VERSION >= (4, 2):
-    from django.core.exceptions import FullResultSet
+    from django.core.exceptions import EmptyResultSet, FullResultSet
 
 def _as_sql_agv(self, compiler, connection):
     return self.as_sql(compiler, connection, template='%(function)s(CONVERT(float, %(field)s))')
@@ -241,6 +241,11 @@ def as_sql(self, with_limits=True, with_col_aliases=False):
                 if django.VERSION >= (4, 2):
                     try:
                         where, w_params = self.compile(self.where) if self.where is not None else ("", [])
+                    except EmptyResultSet:
+                        if self.elide_empty:
+                            raise
+                        # Use a predicate that's always False.
+                        where, w_params = "0 = 1", []
                     except FullResultSet:
                         where, w_params = "", []
                     try:

mssql/features.py

@@ -13,7 +13,7 @@ class DatabaseFeatures(BaseDatabaseFeatures):
     can_introspect_small_integer_field = True
     can_return_columns_from_insert = True
     can_return_id_from_insert = True
-    can_return_rows_from_bulk_insert = False
+    can_return_rows_from_bulk_insert = True
     can_rollback_ddl = True
     can_use_chunked_reads = False
     for_update_after_from = True
@@ -33,6 +33,7 @@ class DatabaseFeatures(BaseDatabaseFeatures):
     requires_literal_defaults = True
     requires_sqlparse_for_splitting = False
     supports_boolean_expr_in_select_clause = False
+    supports_comments = True
     supports_covering_indexes = True
     supports_deferrable_unique_constraints = False
     supports_expression_indexes = False
@@ -56,6 +57,9 @@ class DatabaseFeatures(BaseDatabaseFeatures):
     supports_partially_nullable_unique_constraints = True
     supports_partial_indexes = True
     supports_functions_in_partial_indexes = True
+    supports_default_keyword_in_insert = True
+    supports_expression_defaults = True
+    supports_default_keyword_in_bulk_insert = True
 
     @cached_property
     def has_zoneinfo_database(self):

mssql/functions.py

@@ -32,6 +32,16 @@
 class TryCast(Cast):
     function = 'TRY_CAST'
 
+def sqlserver_cast(self, compiler, connection, **extra_context):
+    if hasattr(self.source_expressions[0], 'lookup_name'):
+        if self.source_expressions[0].lookup_name in ['gt', 'gte', 'lt', 'lte']:
+            return self.as_sql(
+                compiler, connection,
+                template = 'CASE WHEN %(expressions)s THEN 1 ELSE 0 END',
+                **extra_context
+            )
+    return self.as_sql(compiler, connection, **extra_context)
+    
 
 def sqlserver_atan2(self, compiler, connection, **extra_context):
     return self.as_sql(compiler, connection, function='ATN2', **extra_context)
@@ -451,6 +461,7 @@ def sqlserver_sha512(self, compiler, connection, **extra_context):
     key_transform_exact_process_rhs = KeyTransformExact.process_rhs
     KeyTransformExact.process_rhs = json_KeyTransformExact_process_rhs
     HasKeyLookup.as_microsoft = json_HasKeyLookup
+Cast.as_microsoft = sqlserver_cast
 Degrees.as_microsoft = sqlserver_degrees
 Radians.as_microsoft = sqlserver_radians
 Power.as_microsoft = sqlserver_power

mssql/introspection.py

@@ -4,17 +4,22 @@
 from django.db import DatabaseError
 import pyodbc as Database
 
+from collections import namedtuple
+
 from django import VERSION
-from django.db.backends.base.introspection import (
-    BaseDatabaseIntrospection, FieldInfo, TableInfo,
-)
+from django.db.backends.base.introspection import BaseDatabaseIntrospection
+from django.db.backends.base.introspection import FieldInfo as BaseFieldInfo
+from django.db.backends.base.introspection import TableInfo as BaseTableInfo
 from django.db.models.indexes import Index
 from django.conf import settings
 
 SQL_AUTOFIELD = -777555
 SQL_BIGAUTOFIELD = -777444
+SQL_SMALLAUTOFIELD = -777333
 SQL_TIMESTAMP_WITH_TIMEZONE = -155
 
+FieldInfo = namedtuple("FieldInfo", BaseFieldInfo._fields + ("comment",))
+TableInfo = namedtuple("TableInfo", BaseTableInfo._fields + ("comment",))
 
 def get_schema_name():
     return getattr(settings, 'SCHEMA_TO_INSPECT', 'SCHEMA_NAME()')
@@ -25,6 +30,7 @@ class DatabaseIntrospection(BaseDatabaseIntrospection):
     data_types_reverse = {
         SQL_AUTOFIELD: 'AutoField',
         SQL_BIGAUTOFIELD: 'BigAutoField',
+        SQL_SMALLAUTOFIELD: 'SmallAutoField',
         Database.SQL_BIGINT: 'BigIntegerField',
         # Database.SQL_BINARY:            ,
         Database.SQL_BIT: 'BooleanField',
@@ -71,13 +77,26 @@ def get_table_list(self, cursor):
         """
         Returns a list of table and view names in the current database.
         """
-        sql = 'SELECT TABLE_NAME, TABLE_TYPE FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = %s' % (
+        sql = """SELECT
+                    TABLE_NAME,
+                    TABLE_TYPE,
+                    CAST(ep.value AS VARCHAR) AS COMMENT
+                FROM INFORMATION_SCHEMA.TABLES i
+                LEFT JOIN sys.tables t ON t.name = i.TABLE_NAME
+                LEFT JOIN sys.extended_properties ep ON t.object_id = ep.major_id
+                AND ((ep.name = 'MS_DESCRIPTION' AND ep.minor_id = 0) OR ep.value IS NULL)
+                AND i.TABLE_SCHEMA = %s""" % (
             get_schema_name())
         cursor.execute(sql)
         types = {'BASE TABLE': 't', 'VIEW': 'v'}
-        return [TableInfo(row[0], types.get(row[1]))
-                for row in cursor.fetchall()
-                if row[0] not in self.ignored_tables]
+        if VERSION >= (4, 2):
+            return [TableInfo(row[0], types.get(row[1]), row[2])
+                    for row in cursor.fetchall()
+                    if row[0] not in self.ignored_tables]
+        else:
+            return [BaseTableInfo(row[0], types.get(row[1]))
+                    for row in cursor.fetchall()
+                    if row[0] not in self.ignored_tables]
 
     def _is_auto_field(self, cursor, table_name, column_name):
         """
@@ -111,7 +130,7 @@ def get_table_description(self, cursor, table_name, identity_check=True):
 
         if not columns:
             raise DatabaseError(f"Table {table_name} does not exist.")
-            
+
         items = []
         for column in columns:
             if VERSION >= (3, 2):
@@ -126,15 +145,40 @@ def get_table_description(self, cursor, table_name, identity_check=True):
                     column.append(collation_name[0] if collation_name else '')
                 else:
                     column.append('')
-
+            if VERSION >= (4, 2):
+                sql = """select CAST(ep.value AS VARCHAR) AS COMMENT
+                        FROM sys.columns c
+                        INNER JOIN sys.tables t ON c.object_id = t.object_id
+                        INNER JOIN sys.extended_properties ep ON c.object_id=ep.major_id AND ep.minor_id = c.column_id
+                        WHERE t.name = '%s' AND c.name = '%s' AND ep.name = 'MS_Description'
+                        """ % (table_name, column[0])
+                cursor.execute(sql)
+                comment = cursor.fetchone()
+                column.append(comment[0] if comment else '')
             if identity_check and self._is_auto_field(cursor, table_name, column[0]):
                 if column[1] == Database.SQL_BIGINT:
                     column[1] = SQL_BIGAUTOFIELD
+                elif column[1] == Database.SQL_SMALLINT:
+                    column[1] = SQL_SMALLAUTOFIELD
                 else:
                     column[1] = SQL_AUTOFIELD
             if column[1] == Database.SQL_WVARCHAR and column[3] < 4000:
                 column[1] = Database.SQL_WCHAR
-            items.append(FieldInfo(*column))
+            # Remove surrounding parentheses for default values
+            if column[7]:
+                default_value = column[7]
+                start = 0
+                end = -1
+                for _ in range(2):
+                    if default_value[start] == '(' and default_value[end] == ')':
+                        start += 1
+                        end -= 1
+                column[7] = default_value[start:end + 1]
+
+            if VERSION >= (4, 2):
+                items.append(FieldInfo(*column))
+            else:
+                items.append(BaseFieldInfo(*column))
         return items
 
     def get_sequences(self, cursor, table_name, table_fields=()):
@@ -271,6 +315,7 @@ def get_constraints(self, cursor, table_name):
                     # Potentially misleading: primary key and unique constraints still have indexes attached to them.
                     # Should probably be updated with the additional info from the sys.indexes table we fetch later on.
                     "index": False,
+                    "default": False,
                 }
             # Record the details
             constraints[constraint]['columns'].append(column)
@@ -298,6 +343,32 @@ def get_constraints(self, cursor, table_name):
                     "foreign_key": None,
                     "check": True,
                     "index": False,
+                    "default": False,
+                }
+            # Record the details
+            constraints[constraint]['columns'].append(column)
+        # Now get DEFAULT constraint columns
+        cursor.execute("""
+            SELECT
+                [name],
+                COL_NAME([parent_object_id], [parent_column_id])
+            FROM
+                [sys].[default_constraints]
+            WHERE
+                OBJECT_NAME([parent_object_id]) = %s
+        """, [table_name])
+        for constraint, column in cursor.fetchall():
+            # If we're the first column, make the record
+            if constraint not in constraints:
+                constraints[constraint] = {
+                    "columns": [],
+                    "primary_key": False,
+                    "unique": False,
+                    "unique_constraint": False,
+                    "foreign_key": None,
+                    "check": False,
+                    "index": False,
+                    "default": True,
                 }
             # Record the details
             constraints[constraint]['columns'].append(column)
@@ -341,6 +412,7 @@ def get_constraints(self, cursor, table_name):
                     "unique_constraint": unique_constraint,
                     "foreign_key": None,
                     "check": False,
+                    "default": False,
                     "index": True,
                     "orders": [],
                     "type": Index.suffix if type_ in (1, 2) else desc.lower(),

mssql/operations.py

@@ -178,7 +178,7 @@ def date_trunc_sql(self, lookup_type, sql, params, tzname=None):
 
             # Python formats year with leading zeroes. This preserves that format for 
             # compatibility with SQL Server's date since DATEPART drops the leading zeroes.
-            CONVERT_YEAR = 'CONVERT(varchar(4), %s)' % sql
+            CONVERT_YEAR = 'CONVERT(varchar(4), CONVERT(date, %s))' % sql
             CONVERT_QUARTER = 'CONVERT(varchar, 1+((DATEPART(quarter, %s)-1)*3))' % sql
             CONVERT_MONTH = 'CONVERT(varchar, DATEPART(month, %s))' % sql
             CONVERT_WEEK = "DATEADD(DAY, (DATEPART(weekday, %s) + 5) %%%% 7 * -1, %s)" % (sql, sql)