2006-05-02 09:31:56 +08:00
|
|
|
"""
|
|
|
|
MySQL database backend for Django.
|
|
|
|
|
|
|
|
Requires MySQLdb: http://sourceforge.net/projects/mysql-python
|
|
|
|
"""
|
|
|
|
|
|
|
|
from django.db.backends import util
|
2006-05-27 02:58:46 +08:00
|
|
|
try:
|
|
|
|
import MySQLdb as Database
|
|
|
|
except ImportError, e:
|
|
|
|
from django.core.exceptions import ImproperlyConfigured
|
|
|
|
raise ImproperlyConfigured, "Error loading MySQLdb module: %s" % e
|
2007-03-19 03:16:47 +08:00
|
|
|
|
|
|
|
# We want version (1, 2, 1, 'final', 2) or later. We can't just use
|
|
|
|
# lexicographic ordering in this check because then (1, 2, 1, 'gamma')
|
|
|
|
# inadvertently passes the version test.
|
|
|
|
version = Database.version_info
|
2007-05-21 09:29:58 +08:00
|
|
|
if (version < (1,2,1) or (version[:3] == (1, 2, 1) and
|
2007-03-19 03:16:47 +08:00
|
|
|
(len(version) < 5 or version[3] != 'final' or version[4] < 2))):
|
|
|
|
raise ImportError, "MySQLdb-1.2.1p2 or newer is required; you have %s" % Database.__version__
|
2007-03-14 20:08:19 +08:00
|
|
|
|
2006-05-02 09:31:56 +08:00
|
|
|
from MySQLdb.converters import conversions
|
|
|
|
from MySQLdb.constants import FIELD_TYPE
|
|
|
|
import types
|
2006-09-27 10:42:31 +08:00
|
|
|
import re
|
2006-05-02 09:31:56 +08:00
|
|
|
|
|
|
|
DatabaseError = Database.DatabaseError
|
2007-04-25 18:18:56 +08:00
|
|
|
IntegrityError = Database.IntegrityError
|
2006-05-02 09:31:56 +08:00
|
|
|
|
2007-03-14 20:08:19 +08:00
|
|
|
# MySQLdb-1.2.1 supports the Python boolean type, and only uses datetime
|
|
|
|
# module for time-related columns; older versions could have used mx.DateTime
|
|
|
|
# or strings if there were no datetime module. However, MySQLdb still returns
|
|
|
|
# TIME columns as timedelta -- they are more like timedelta in terms of actual
|
|
|
|
# behavior as they are signed and include days -- and Django expects time, so
|
|
|
|
# we still need to override that.
|
2006-05-02 09:31:56 +08:00
|
|
|
django_conversions = conversions.copy()
|
|
|
|
django_conversions.update({
|
|
|
|
FIELD_TYPE.TIME: util.typecast_time,
|
2007-05-21 09:29:58 +08:00
|
|
|
FIELD_TYPE.DECIMAL: util.typecast_decimal,
|
|
|
|
FIELD_TYPE.NEWDECIMAL: util.typecast_decimal,
|
2006-05-02 09:31:56 +08:00
|
|
|
})
|
|
|
|
|
2006-09-27 10:42:31 +08:00
|
|
|
# This should match the numerical portion of the version numbers (we can treat
|
|
|
|
# versions like 5.0.24 and 5.0.24a as the same). Based on the list of version
|
|
|
|
# at http://dev.mysql.com/doc/refman/4.1/en/news.html and
|
|
|
|
# http://dev.mysql.com/doc/refman/5.0/en/news.html .
|
|
|
|
server_version_re = re.compile(r'(\d{1,2})\.(\d{1,2})\.(\d{1,2})')
|
|
|
|
|
2007-03-14 20:08:19 +08:00
|
|
|
# MySQLdb-1.2.1 and newer automatically makes use of SHOW WARNINGS on
|
|
|
|
# MySQL-4.1 and newer, so the MysqlDebugWrapper is unnecessary. Since the
|
|
|
|
# point is to raise Warnings as exceptions, this can be done with the Python
|
|
|
|
# warning module, and this is setup when the connection is created, and the
|
|
|
|
# standard util.CursorDebugWrapper can be used. Also, using sql_mode
|
|
|
|
# TRADITIONAL will automatically cause most warnings to be treated as errors.
|
2006-05-02 09:31:56 +08:00
|
|
|
|
|
|
|
try:
|
|
|
|
# Only exists in Python 2.4+
|
|
|
|
from threading import local
|
|
|
|
except ImportError:
|
|
|
|
# Import copy of _thread_local.py from Python 2.4
|
|
|
|
from django.utils._threading_local import local
|
|
|
|
|
|
|
|
class DatabaseWrapper(local):
|
2006-11-07 13:17:38 +08:00
|
|
|
def __init__(self, **kwargs):
|
2006-05-02 09:31:56 +08:00
|
|
|
self.connection = None
|
|
|
|
self.queries = []
|
2006-09-27 10:42:31 +08:00
|
|
|
self.server_version = None
|
2006-11-07 13:17:38 +08:00
|
|
|
self.options = kwargs
|
2006-05-02 09:31:56 +08:00
|
|
|
|
|
|
|
def _valid_connection(self):
|
|
|
|
if self.connection is not None:
|
|
|
|
try:
|
|
|
|
self.connection.ping()
|
|
|
|
return True
|
|
|
|
except DatabaseError:
|
|
|
|
self.connection.close()
|
|
|
|
self.connection = None
|
|
|
|
return False
|
|
|
|
|
|
|
|
def cursor(self):
|
|
|
|
from django.conf import settings
|
2007-03-14 20:08:19 +08:00
|
|
|
from warnings import filterwarnings
|
2006-05-02 09:31:56 +08:00
|
|
|
if not self._valid_connection():
|
|
|
|
kwargs = {
|
|
|
|
'conv': django_conversions,
|
2007-03-21 07:32:39 +08:00
|
|
|
'charset': 'utf8',
|
Merged Unicode branch into trunk (r4952:5608). This should be fully
backwards compatible for all practical purposes.
Fixed #2391, #2489, #2996, #3322, #3344, #3370, #3406, #3432, #3454, #3492, #3582, #3690, #3878, #3891, #3937, #4039, #4141, #4227, #4286, #4291, #4300, #4452, #4702
git-svn-id: http://code.djangoproject.com/svn/django/trunk@5609 bcc190cf-cafb-0310-a4f2-bffc1f526a37
2007-07-04 20:11:04 +08:00
|
|
|
'use_unicode': True,
|
2006-05-02 09:31:56 +08:00
|
|
|
}
|
2007-03-14 20:08:19 +08:00
|
|
|
if settings.DATABASE_USER:
|
|
|
|
kwargs['user'] = settings.DATABASE_USER
|
|
|
|
if settings.DATABASE_NAME:
|
|
|
|
kwargs['db'] = settings.DATABASE_NAME
|
|
|
|
if settings.DATABASE_PASSWORD:
|
|
|
|
kwargs['passwd'] = settings.DATABASE_PASSWORD
|
2006-05-02 09:31:56 +08:00
|
|
|
if settings.DATABASE_HOST.startswith('/'):
|
|
|
|
kwargs['unix_socket'] = settings.DATABASE_HOST
|
2007-03-14 20:08:19 +08:00
|
|
|
elif settings.DATABASE_HOST:
|
2006-05-02 09:31:56 +08:00
|
|
|
kwargs['host'] = settings.DATABASE_HOST
|
|
|
|
if settings.DATABASE_PORT:
|
|
|
|
kwargs['port'] = int(settings.DATABASE_PORT)
|
2006-11-07 13:17:38 +08:00
|
|
|
kwargs.update(self.options)
|
2006-05-02 09:31:56 +08:00
|
|
|
self.connection = Database.connect(**kwargs)
|
2006-12-30 15:21:01 +08:00
|
|
|
cursor = self.connection.cursor()
|
|
|
|
else:
|
|
|
|
cursor = self.connection.cursor()
|
2006-05-02 09:31:56 +08:00
|
|
|
if settings.DEBUG:
|
2007-03-14 20:08:19 +08:00
|
|
|
filterwarnings("error", category=Database.Warning)
|
|
|
|
return util.CursorDebugWrapper(cursor, self)
|
2006-05-02 09:31:56 +08:00
|
|
|
return cursor
|
|
|
|
|
|
|
|
def _commit(self):
|
2007-03-09 15:55:40 +08:00
|
|
|
if self.connection is not None:
|
|
|
|
self.connection.commit()
|
2006-05-02 09:31:56 +08:00
|
|
|
|
|
|
|
def _rollback(self):
|
2007-03-09 15:55:40 +08:00
|
|
|
if self.connection is not None:
|
2006-05-02 09:31:56 +08:00
|
|
|
try:
|
|
|
|
self.connection.rollback()
|
|
|
|
except Database.NotSupportedError:
|
|
|
|
pass
|
|
|
|
|
|
|
|
def close(self):
|
|
|
|
if self.connection is not None:
|
|
|
|
self.connection.close()
|
|
|
|
self.connection = None
|
|
|
|
|
2006-09-27 10:42:31 +08:00
|
|
|
def get_server_version(self):
|
|
|
|
if not self.server_version:
|
|
|
|
if not self._valid_connection():
|
|
|
|
self.cursor()
|
|
|
|
m = server_version_re.match(self.connection.get_server_info())
|
|
|
|
if not m:
|
|
|
|
raise Exception('Unable to determine MySQL version from version string %r' % self.connection.get_server_info())
|
2006-09-27 10:47:19 +08:00
|
|
|
self.server_version = tuple([int(x) for x in m.groups()])
|
2006-09-27 10:42:31 +08:00
|
|
|
return self.server_version
|
|
|
|
|
2007-06-23 22:16:00 +08:00
|
|
|
allows_group_by_ordinal = True
|
|
|
|
allows_unique_and_pk = True
|
|
|
|
autoindexes_primary_keys = False
|
|
|
|
needs_datetime_string_cast = True # MySQLdb requires a typecast for dates
|
|
|
|
needs_upper_for_iops = False
|
2006-05-02 09:31:56 +08:00
|
|
|
supports_constraints = True
|
2007-06-23 22:16:00 +08:00
|
|
|
supports_tablespaces = False
|
|
|
|
uses_case_insensitive_names = False
|
2006-05-02 09:31:56 +08:00
|
|
|
|
|
|
|
def quote_name(name):
|
|
|
|
if name.startswith("`") and name.endswith("`"):
|
|
|
|
return name # Quoting once is enough.
|
|
|
|
return "`%s`" % name
|
|
|
|
|
|
|
|
dictfetchone = util.dictfetchone
|
|
|
|
dictfetchmany = util.dictfetchmany
|
|
|
|
dictfetchall = util.dictfetchall
|
|
|
|
|
|
|
|
def get_last_insert_id(cursor, table_name, pk_name):
|
|
|
|
return cursor.lastrowid
|
|
|
|
|
|
|
|
def get_date_extract_sql(lookup_type, table_name):
|
|
|
|
# lookup_type is 'year', 'month', 'day'
|
|
|
|
# http://dev.mysql.com/doc/mysql/en/date-and-time-functions.html
|
|
|
|
return "EXTRACT(%s FROM %s)" % (lookup_type.upper(), table_name)
|
|
|
|
|
|
|
|
def get_date_trunc_sql(lookup_type, field_name):
|
|
|
|
# lookup_type is 'year', 'month', 'day'
|
|
|
|
fields = ['year', 'month', 'day', 'hour', 'minute', 'second']
|
|
|
|
format = ('%%Y-', '%%m', '-%%d', ' %%H:', '%%i', ':%%s') # Use double percents to escape.
|
|
|
|
format_def = ('0000-', '01', '-01', ' 00:', '00', ':00')
|
|
|
|
try:
|
|
|
|
i = fields.index(lookup_type) + 1
|
|
|
|
except ValueError:
|
|
|
|
sql = field_name
|
|
|
|
else:
|
|
|
|
format_str = ''.join([f for f in format[:i]] + [f for f in format_def[i:]])
|
|
|
|
sql = "CAST(DATE_FORMAT(%s, '%s') AS DATETIME)" % (field_name, format_str)
|
|
|
|
return sql
|
|
|
|
|
2007-06-23 22:16:00 +08:00
|
|
|
def get_datetime_cast_sql():
|
|
|
|
return None
|
|
|
|
|
2006-05-02 09:31:56 +08:00
|
|
|
def get_limit_offset_sql(limit, offset=None):
|
|
|
|
sql = "LIMIT "
|
|
|
|
if offset and offset != 0:
|
|
|
|
sql += "%s," % offset
|
|
|
|
return sql + str(limit)
|
|
|
|
|
|
|
|
def get_random_function_sql():
|
|
|
|
return "RAND()"
|
|
|
|
|
2007-02-27 01:33:27 +08:00
|
|
|
def get_deferrable_sql():
|
|
|
|
return ""
|
|
|
|
|
2006-06-04 07:28:24 +08:00
|
|
|
def get_fulltext_search_sql(field_name):
|
|
|
|
return 'MATCH (%s) AGAINST (%%s IN BOOLEAN MODE)' % field_name
|
|
|
|
|
2006-05-02 09:31:56 +08:00
|
|
|
def get_drop_foreignkey_sql():
|
|
|
|
return "DROP FOREIGN KEY"
|
|
|
|
|
2006-06-08 23:14:06 +08:00
|
|
|
def get_pk_default_value():
|
|
|
|
return "DEFAULT"
|
|
|
|
|
2007-06-23 22:16:00 +08:00
|
|
|
def get_max_name_length():
|
|
|
|
return None;
|
|
|
|
|
|
|
|
def get_start_transaction_sql():
|
|
|
|
return "BEGIN;"
|
|
|
|
|
|
|
|
def get_autoinc_sql(table):
|
|
|
|
return None
|
|
|
|
|
2007-03-01 21:11:08 +08:00
|
|
|
def get_sql_flush(style, tables, sequences):
|
|
|
|
"""Return a list of SQL statements required to remove all data from
|
|
|
|
all tables in the database (without actually removing the tables
|
|
|
|
themselves) and put the database in an empty 'initial' state
|
2007-06-23 22:16:00 +08:00
|
|
|
|
2007-03-01 21:11:08 +08:00
|
|
|
"""
|
|
|
|
# NB: The generated SQL below is specific to MySQL
|
|
|
|
# 'TRUNCATE x;', 'TRUNCATE y;', 'TRUNCATE z;'... style SQL statements
|
|
|
|
# to clear all tables of all data
|
|
|
|
if tables:
|
|
|
|
sql = ['SET FOREIGN_KEY_CHECKS = 0;'] + \
|
|
|
|
['%s %s;' % \
|
|
|
|
(style.SQL_KEYWORD('TRUNCATE'),
|
|
|
|
style.SQL_FIELD(quote_name(table))
|
|
|
|
) for table in tables] + \
|
|
|
|
['SET FOREIGN_KEY_CHECKS = 1;']
|
2007-06-23 22:16:00 +08:00
|
|
|
|
2007-03-01 21:11:08 +08:00
|
|
|
# 'ALTER TABLE table AUTO_INCREMENT = 1;'... style SQL statements
|
|
|
|
# to reset sequence indices
|
|
|
|
sql.extend(["%s %s %s %s %s;" % \
|
|
|
|
(style.SQL_KEYWORD('ALTER'),
|
|
|
|
style.SQL_KEYWORD('TABLE'),
|
|
|
|
style.SQL_TABLE(quote_name(sequence['table'])),
|
|
|
|
style.SQL_KEYWORD('AUTO_INCREMENT'),
|
|
|
|
style.SQL_FIELD('= 1'),
|
|
|
|
) for sequence in sequences])
|
|
|
|
return sql
|
|
|
|
else:
|
|
|
|
return []
|
|
|
|
|
2007-04-06 10:25:58 +08:00
|
|
|
def get_sql_sequence_reset(style, model_list):
|
|
|
|
"Returns a list of the SQL statements to reset sequences for the given models."
|
|
|
|
# No sequence reset required
|
|
|
|
return []
|
|
|
|
|
2006-05-02 09:31:56 +08:00
|
|
|
OPERATOR_MAPPING = {
|
|
|
|
'exact': '= %s',
|
|
|
|
'iexact': 'LIKE %s',
|
|
|
|
'contains': 'LIKE BINARY %s',
|
|
|
|
'icontains': 'LIKE %s',
|
2007-06-28 02:58:10 +08:00
|
|
|
'regex': 'REGEXP BINARY %s',
|
|
|
|
'iregex': 'REGEXP %s',
|
2006-05-02 09:31:56 +08:00
|
|
|
'gt': '> %s',
|
|
|
|
'gte': '>= %s',
|
|
|
|
'lt': '< %s',
|
|
|
|
'lte': '<= %s',
|
|
|
|
'startswith': 'LIKE BINARY %s',
|
|
|
|
'endswith': 'LIKE BINARY %s',
|
|
|
|
'istartswith': 'LIKE %s',
|
|
|
|
'iendswith': 'LIKE %s',
|
|
|
|
}
|