drop support for the deprecated database settings

michiya · michiya · commit 3f61b4b3228b · 2013-06-11T18:08:49.000+09:00
diff --git a/README.md b/README.md
@@ -60,14 +60,21 @@ The following settings control the behavior of the backend:
 
 `OPTIONS` Dictionary. Current available keys are:
 
+    ``driver``
+        String. ODBC Driver to use. Default is ``"SQL Server"`` on Windows and
+        ``"FreeTDS"`` on other platforms.
+
+    ``dsn``
+        String. A named DSN can be used instead of ``HOST``.
+
     ``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 running on Windows and with SQL Server 2005
         or later through MS *SQL Server Native client* driver (i.e. setting
-	``DATABASE_ODBC_DRIVER`` to ``"SQL Native Client"``). See
+        ``driver`` to ``"SQL Server Native Client 11.0"``). See
         http://msdn.microsoft.com/en-us/library/ms131686.aspx.
         Default value is ``False``.
 
@@ -87,23 +94,15 @@ The following settings control the behavior of the backend:
 
         See http://freetds.org/userguide/dsnless.htm for more information.
 
-### ``django-pyodbc``-specific settings
-
-``ODBC_DSN``
-    String. A named DSN can be used instead of ``DATABASE_HOST``.
-
-``ODBC_DRIVER``
-    String. ODBC Driver to use. Default is ``"SQL Server"`` on Windows and
-    ``"FreeTDS"`` on other platforms.
-
-``EXTRA_PARAMS``
-    String. Additional parameters for the ODBC connection. The format is
-    ``"param=value;param=value"``.
+    ``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 value is ``"Latin1_General_CI_AS"``.
-    For Chinese language you can set it to ``"Chinese_PRC_CI_AS"``.
+    ``collation``
+        String. Name of the collation to use when performing text field lookups
+        against the database. For Chinese language you can set it to 
+        ``"Chinese_PRC_CI_AS"``. The default collation for the database
+        will be used if no value is specified.
 
 License
 -------
diff --git a/django_pyodbc/base.py b/django_pyodbc/base.py
@@ -1,24 +1,21 @@
 """
 MS SQL Server database backend for Django.
 """
-
-import logging
 import os
 import re
-import warnings
+
+from django.core.exceptions import ImproperlyConfigured
 
 try:
     import pyodbc as Database
 except ImportError, e:
-    from django.core.exceptions import ImproperlyConfigured
     raise ImproperlyConfigured("Error loading pyodbc module: %s" % e)
 
 m = re.match(r'(\d+)\.(\d+)\.(\d+)(?:-beta(\d+))?', Database.version)
 vlist = list(m.groups())
 if vlist[3] is None: vlist[3] = '9999'
 pyodbc_ver = tuple(map(int, vlist))
 if pyodbc_ver < (2, 0, 38, 9999):
-    from django.core.exceptions import ImproperlyConfigured
     raise ImproperlyConfigured("pyodbc 2.0.38 or newer is required; you have %s" % Database.version)
 
 from django.db.backends import BaseDatabaseWrapper, BaseDatabaseFeatures, BaseDatabaseValidation
@@ -41,35 +38,6 @@
 from django_pyodbc.creation import DatabaseCreation
 from django_pyodbc.introspection import DatabaseIntrospection
 
-warnings.filterwarnings('error', 'The DATABASE_ODBC.+ is deprecated', DeprecationWarning, __name__, 0)
-
-logger = logging.getLogger(__name__)
-
-collation = 'Latin1_General_CI_AS'
-try:
-    if hasattr(settings, 'DATABASE_COLLATION'):
-        warnings.warn(
-            "The DATABASE_COLLATION setting is going to be deprecated, use DATABASE_OPTIONS['collation'] instead.",
-            DeprecationWarning
-        )
-        collation = settings.DATABASE_COLLATION
-    elif 'collation' in settings.DATABASE_OPTIONS:
-        collation = settings.DATABASE_OPTIONS['collation']
-except AttributeError:
-    pass
-
-deprecated = (
-    ('DATABASE_ODBC_DRIVER', 'driver'),
-    ('DATABASE_ODBC_DSN', 'dsn'),
-    ('DATABASE_ODBC_EXTRA_PARAMS', 'extra_params'),
-)
-for old, new in deprecated:
-    if hasattr(settings, old):
-        warnings.warn(
-            "The %s setting is deprecated, use DATABASE_OPTIONS['%s'] instead." % (old, new),
-            DeprecationWarning
-        )
-
 DatabaseError = Database.DatabaseError
 IntegrityError = Database.IntegrityError
 
@@ -101,33 +69,46 @@ class DatabaseWrapper(BaseDatabaseWrapper):
         # database collation.
         'exact': '= %s',
         'iexact': "= UPPER(%s)",
-        'contains': "LIKE %s ESCAPE '\\' COLLATE " + collation,
-        'icontains': "LIKE UPPER(%s) ESCAPE '\\' COLLATE "+ collation,
+        'contains': "LIKE %s ESCAPE '\\'",
+        'icontains': "LIKE UPPER(%s) ESCAPE '\\'",
         'gt': '> %s',
         'gte': '>= %s',
         'lt': '< %s',
         'lte': '<= %s',
-        'startswith': "LIKE %s ESCAPE '\\' COLLATE " + collation,
-        'endswith': "LIKE %s ESCAPE '\\' COLLATE " + collation,
-        'istartswith': "LIKE UPPER(%s) ESCAPE '\\' COLLATE " + collation,
-        'iendswith': "LIKE UPPER(%s) ESCAPE '\\' COLLATE " + collation,
+        'startswith': "LIKE %s ESCAPE '\\'",
+        'endswith': "LIKE %s ESCAPE '\\'",
+        'istartswith': "LIKE UPPER(%s) ESCAPE '\\'",
+        'iendswith': "LIKE UPPER(%s) ESCAPE '\\'",
 
         # TODO: remove, keep native T-SQL LIKE wildcards support
         # or use a "compatibility layer" and replace '*' with '%'
         # and '.' with '_'
-        'regex': 'LIKE %s COLLATE ' + collation,
-        'iregex': 'LIKE %s COLLATE ' + collation,
+        'regex': 'LIKE %s',
+        'iregex': 'LIKE %s',
 
         # TODO: freetext, full-text contains...
     }
 
     def __init__(self, *args, **kwargs):
         super(DatabaseWrapper, self).__init__(*args, **kwargs)
 
-        if 'OPTIONS' in self.settings_dict:
-            self.MARS_Connection = self.settings_dict['OPTIONS'].get('MARS_Connection', False)
-            self.datefirst = self.settings_dict['OPTIONS'].get('datefirst', 7)
-            self.unicode_results = self.settings_dict['OPTIONS'].get('unicode_results', False)
+        options = self.settings_dict.get('OPTIONS', None)
+
+        if options:
+            self.MARS_Connection = options.get('MARS_Connection', False)
+            self.datefirst = options.get('datefirst', 7)
+            self.unicode_results = options.get('unicode_results', False)
+            
+            # make lookup operators to be collation-sensitive if needed
+            self.collation = options.get('collation', None)
+            if self.collation:
+                self.operators = dict(self.__class__.operators)
+                ops = {}
+                for op in self.operators:
+                    sql = self.operators[op]
+                    if sql.startswith('LIKE '):
+                        ops[op] = '%s COLLATE %s' % (sql, self.collation)
+                self.operators.update(ops)
 
         if _DJANGO_VERSION >= 13:
             self.features = DatabaseFeatures(self)
@@ -145,38 +126,24 @@ def _cursor(self):
         new_conn = False
         settings_dict = self.settings_dict
         db_str, user_str, passwd_str, port_str = None, None, "", None
-        if _DJANGO_VERSION >= 12:
-            options = settings_dict['OPTIONS']
-            if settings_dict['NAME']:
-                db_str = settings_dict['NAME']
-            if settings_dict['HOST']:
-                host_str = settings_dict['HOST']
-            else:
-                host_str = 'localhost'
-            if settings_dict['USER']:
-                user_str = settings_dict['USER']
-            if settings_dict['PASSWORD']:
-                passwd_str = settings_dict['PASSWORD']
-            if settings_dict['PORT']:
-                port_str = settings_dict['PORT']
+
+        options = settings_dict['OPTIONS']
+        if settings_dict['NAME']:
+            db_str = settings_dict['NAME']
+        if settings_dict['HOST']:
+            host_str = settings_dict['HOST']
         else:
-            options = settings_dict['DATABASE_OPTIONS']
-            if settings_dict['DATABASE_NAME']:
-                db_str = settings_dict['DATABASE_NAME']
-            if settings_dict['DATABASE_HOST']:
-                host_str = settings_dict['DATABASE_HOST']
-            else:
-                host_str = 'localhost'
-            if settings_dict['DATABASE_USER']:
-                user_str = settings_dict['DATABASE_USER']
-            if settings_dict['DATABASE_PASSWORD']:
-                passwd_str = settings_dict['DATABASE_PASSWORD']
-            if settings_dict['DATABASE_PORT']:
-                port_str = settings_dict['DATABASE_PORT']
+            host_str = 'localhost'
+        if settings_dict['USER']:
+            user_str = settings_dict['USER']
+        if settings_dict['PASSWORD']:
+            passwd_str = settings_dict['PASSWORD']
+        if settings_dict['PORT']:
+            port_str = settings_dict['PORT']
+
         if self.connection is None:
             new_conn = True
             if not db_str:
-                from django.core.exceptions import ImproperlyConfigured
                 raise ImproperlyConfigured('You need to specify NAME in your Django settings file.')
 
             cstr_parts = []
