web/lib/django/db/backends/postgresql/base.py
author ymh <ymh.work@gmail.com>
Thu, 05 Aug 2010 17:28:09 +0200
changeset 50 012451a812f1
parent 38 77b6da96e6f1
permissions -rw-r--r--
Merge with a2711e44ba5de8b1675d7e0ee6aaa4a6c56a9b46
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
38
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
"""
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
PostgreSQL database backend for Django.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
Requires psycopg 1: http://initd.org/projects/psycopg1
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
"""
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
import sys
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
from django.db import utils
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
from django.db.backends import *
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
from django.db.backends.signals import connection_created
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
from django.db.backends.postgresql.client import DatabaseClient
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
from django.db.backends.postgresql.creation import DatabaseCreation
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
from django.db.backends.postgresql.introspection import DatabaseIntrospection
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
from django.db.backends.postgresql.operations import DatabaseOperations
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
from django.db.backends.postgresql.version import get_version
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
from django.utils.encoding import smart_str, smart_unicode
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
    import psycopg as Database
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
except ImportError, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
    from django.core.exceptions import ImproperlyConfigured
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
    raise ImproperlyConfigured("Error loading psycopg module: %s" % e)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
DatabaseError = Database.DatabaseError
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
IntegrityError = Database.IntegrityError
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
class UnicodeCursorWrapper(object):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
    """
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
    A thin wrapper around psycopg cursors that allows them to accept Unicode
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
    strings as params.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
    This is necessary because psycopg doesn't apply any DB quoting to
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
    parameters that are Unicode strings. If a param is Unicode, this will
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
    convert it to a bytestring using database client's encoding before passing
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
    it to psycopg.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
    All results retrieved from the database are converted into Unicode strings
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
    before being returned to the caller.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
    """
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
    def __init__(self, cursor, charset):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
        self.cursor = cursor
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
        self.charset = charset
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
    def format_params(self, params):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
        if isinstance(params, dict):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
            result = {}
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
            charset = self.charset
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
            for key, value in params.items():
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
                result[smart_str(key, charset)] = smart_str(value, charset)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
            return result
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
        else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
            return tuple([smart_str(p, self.charset, True) for p in params])
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
    def execute(self, sql, params=()):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
        try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
            return self.cursor.execute(smart_str(sql, self.charset), self.format_params(params))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
        except Database.IntegrityError, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
            raise utils.IntegrityError, utils.IntegrityError(*tuple(e)), sys.exc_info()[2]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
        except Database.DatabaseError, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
            raise utils.DatabaseError, utils.DatabaseError(*tuple(e)), sys.exc_info()[2]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
    def executemany(self, sql, param_list):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
        try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
            new_param_list = [self.format_params(params) for params in param_list]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
            return self.cursor.executemany(sql, new_param_list)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
        except Database.IntegrityError, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
            raise utils.IntegrityError, utils.IntegrityError(*tuple(e)), sys.exc_info()[2]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
        except Database.DatabaseError, e:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
            raise utils.DatabaseError, utils.DatabaseError(*tuple(e)), sys.exc_info()[2]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
    def __getattr__(self, attr):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
        if attr in self.__dict__:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
            return self.__dict__[attr]
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
        else:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
            return getattr(self.cursor, attr)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
    def __iter__(self):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
        return iter(self.cursor.fetchall())
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
class DatabaseFeatures(BaseDatabaseFeatures):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
    uses_savepoints = True
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
class DatabaseWrapper(BaseDatabaseWrapper):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
    operators = {
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
        'exact': '= %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
        'iexact': '= UPPER(%s)',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
        'contains': 'LIKE %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
        'icontains': 'LIKE UPPER(%s)',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
        'regex': '~ %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
        'iregex': '~* %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
        'gt': '> %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
        'gte': '>= %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
        'lt': '< %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
        'lte': '<= %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
        'startswith': 'LIKE %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
        'endswith': 'LIKE %s',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
        'istartswith': 'LIKE UPPER(%s)',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
        'iendswith': 'LIKE UPPER(%s)',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
    }
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
    def __init__(self, *args, **kwargs):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
        super(DatabaseWrapper, self).__init__(*args, **kwargs)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
        import warnings
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
        warnings.warn(
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
            'The "postgresql" backend has been deprecated. Use "postgresql_psycopg2" instead.',
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
            PendingDeprecationWarning
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
        )
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
        self.features = DatabaseFeatures()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
        self.ops = DatabaseOperations(self)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
        self.client = DatabaseClient(self)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   114
        self.creation = DatabaseCreation(self)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   115
        self.introspection = DatabaseIntrospection(self)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   116
        self.validation = BaseDatabaseValidation(self)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   117
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   118
    def _cursor(self):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   119
        new_connection = False
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   120
        set_tz = False
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   121
        settings_dict = self.settings_dict
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   122
        if self.connection is None:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   123
            new_connection = True
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   124
            set_tz = settings_dict.get('TIME_ZONE')
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   125
            if settings_dict['NAME'] == '':
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   126
                from django.core.exceptions import ImproperlyConfigured
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   127
                raise ImproperlyConfigured("You need to specify NAME in your Django settings file.")
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   128
            conn_string = "dbname=%s" % settings_dict['NAME']
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   129
            if settings_dict['USER']:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   130
                conn_string = "user=%s %s" % (settings_dict['USER'], conn_string)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   131
            if settings_dict['PASSWORD']:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   132
                conn_string += " password='%s'" % settings_dict['PASSWORD']
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   133
            if settings_dict['HOST']:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   134
                conn_string += " host=%s" % settings_dict['HOST']
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   135
            if settings_dict['PORT']:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   136
                conn_string += " port=%s" % settings_dict['PORT']
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   137
            self.connection = Database.connect(conn_string, **settings_dict['OPTIONS'])
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   138
            self.connection.set_isolation_level(1) # make transactions transparent to all cursors
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   139
            connection_created.send(sender=self.__class__)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   140
        cursor = self.connection.cursor()
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   141
        if new_connection:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   142
            if set_tz:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   143
                cursor.execute("SET TIME ZONE %s", [settings_dict['TIME_ZONE']])
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   144
            if not hasattr(self, '_version'):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   145
                self.__class__._version = get_version(cursor)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   146
            if self._version[0:2] < (8, 0):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   147
                # No savepoint support for earlier version of PostgreSQL.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   148
                self.features.uses_savepoints = False
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   149
            cursor.execute("SET client_encoding to 'UNICODE'")
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   150
        return UnicodeCursorWrapper(cursor, 'utf-8')
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   151
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   152
def typecast_string(s):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   153
    """
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   154
    Cast all returned strings to unicode strings.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   155
    """
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   156
    if not s and not isinstance(s, str):
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   157
        return s
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   158
    return smart_unicode(s)
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   159
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   160
# Register these custom typecasts, because Django expects dates/times to be
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   161
# in Python's native (standard-library) datetime/time format, whereas psycopg
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   162
# use mx.DateTime by default.
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   163
try:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   164
    Database.register_type(Database.new_type((1082,), "DATE", util.typecast_date))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   165
except AttributeError:
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   166
    raise Exception("You appear to be using psycopg version 2. Set your DATABASES.ENGINE to 'postgresql_psycopg2' instead of 'postgresql'.")
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   167
Database.register_type(Database.new_type((1083,1266), "TIME", util.typecast_time))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   168
Database.register_type(Database.new_type((1114,1184), "TIMESTAMP", util.typecast_timestamp))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   169
Database.register_type(Database.new_type((16,), "BOOLEAN", util.typecast_boolean))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   170
Database.register_type(Database.new_type((1700,), "NUMERIC", util.typecast_decimal))
77b6da96e6f1 update django
ymh <ymh.work@gmail.com>
parents:
diff changeset
   171
Database.register_type(Database.new_type(Database.types[1043].values, 'STRING', typecast_string))