operations.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380
  1. import uuid
  2. from django.conf import settings
  3. from django.db.backends.base.operations import BaseDatabaseOperations
  4. from django.utils import timezone
  5. from django.utils.encoding import force_str
  6. class DatabaseOperations(BaseDatabaseOperations):
  7. compiler_module = "django.db.backends.mysql.compiler"
  8. # MySQL stores positive fields as UNSIGNED ints.
  9. integer_field_ranges = {
  10. **BaseDatabaseOperations.integer_field_ranges,
  11. 'PositiveSmallIntegerField': (0, 65535),
  12. 'PositiveIntegerField': (0, 4294967295),
  13. 'PositiveBigIntegerField': (0, 18446744073709551615),
  14. }
  15. cast_data_types = {
  16. 'AutoField': 'signed integer',
  17. 'BigAutoField': 'signed integer',
  18. 'SmallAutoField': 'signed integer',
  19. 'CharField': 'char(%(max_length)s)',
  20. 'DecimalField': 'decimal(%(max_digits)s, %(decimal_places)s)',
  21. 'TextField': 'char',
  22. 'IntegerField': 'signed integer',
  23. 'BigIntegerField': 'signed integer',
  24. 'SmallIntegerField': 'signed integer',
  25. 'PositiveBigIntegerField': 'unsigned integer',
  26. 'PositiveIntegerField': 'unsigned integer',
  27. 'PositiveSmallIntegerField': 'unsigned integer',
  28. 'DurationField': 'signed integer',
  29. }
  30. cast_char_field_without_max_length = 'char'
  31. explain_prefix = 'EXPLAIN'
  32. def date_extract_sql(self, lookup_type, field_name):
  33. # https://dev.mysql.com/doc/mysql/en/date-and-time-functions.html
  34. if lookup_type == 'week_day':
  35. # DAYOFWEEK() returns an integer, 1-7, Sunday=1.
  36. return "DAYOFWEEK(%s)" % field_name
  37. elif lookup_type == 'iso_week_day':
  38. # WEEKDAY() returns an integer, 0-6, Monday=0.
  39. return "WEEKDAY(%s) + 1" % field_name
  40. elif lookup_type == 'week':
  41. # Override the value of default_week_format for consistency with
  42. # other database backends.
  43. # Mode 3: Monday, 1-53, with 4 or more days this year.
  44. return "WEEK(%s, 3)" % field_name
  45. elif lookup_type == 'iso_year':
  46. # Get the year part from the YEARWEEK function, which returns a
  47. # number as year * 100 + week.
  48. return "TRUNCATE(YEARWEEK(%s, 3), -2) / 100" % field_name
  49. else:
  50. # EXTRACT returns 1-53 based on ISO-8601 for the week number.
  51. return "EXTRACT(%s FROM %s)" % (lookup_type.upper(), field_name)
  52. def date_trunc_sql(self, lookup_type, field_name, tzname=None):
  53. field_name = self._convert_field_to_tz(field_name, tzname)
  54. fields = {
  55. 'year': '%%Y-01-01',
  56. 'month': '%%Y-%%m-01',
  57. } # Use double percents to escape.
  58. if lookup_type in fields:
  59. format_str = fields[lookup_type]
  60. return "CAST(DATE_FORMAT(%s, '%s') AS DATE)" % (field_name, format_str)
  61. elif lookup_type == 'quarter':
  62. return "MAKEDATE(YEAR(%s), 1) + INTERVAL QUARTER(%s) QUARTER - INTERVAL 1 QUARTER" % (
  63. field_name, field_name
  64. )
  65. elif lookup_type == 'week':
  66. return "DATE_SUB(%s, INTERVAL WEEKDAY(%s) DAY)" % (
  67. field_name, field_name
  68. )
  69. else:
  70. return "DATE(%s)" % (field_name)
  71. def _prepare_tzname_delta(self, tzname):
  72. if '+' in tzname:
  73. return tzname[tzname.find('+'):]
  74. elif '-' in tzname:
  75. return tzname[tzname.find('-'):]
  76. return tzname
  77. def _convert_field_to_tz(self, field_name, tzname):
  78. if tzname and settings.USE_TZ and self.connection.timezone_name != tzname:
  79. field_name = "CONVERT_TZ(%s, '%s', '%s')" % (
  80. field_name,
  81. self.connection.timezone_name,
  82. self._prepare_tzname_delta(tzname),
  83. )
  84. return field_name
  85. def datetime_cast_date_sql(self, field_name, tzname):
  86. field_name = self._convert_field_to_tz(field_name, tzname)
  87. return "DATE(%s)" % field_name
  88. def datetime_cast_time_sql(self, field_name, tzname):
  89. field_name = self._convert_field_to_tz(field_name, tzname)
  90. return "TIME(%s)" % field_name
  91. def datetime_extract_sql(self, lookup_type, field_name, tzname):
  92. field_name = self._convert_field_to_tz(field_name, tzname)
  93. return self.date_extract_sql(lookup_type, field_name)
  94. def datetime_trunc_sql(self, lookup_type, field_name, tzname):
  95. field_name = self._convert_field_to_tz(field_name, tzname)
  96. fields = ['year', 'month', 'day', 'hour', 'minute', 'second']
  97. format = ('%%Y-', '%%m', '-%%d', ' %%H:', '%%i', ':%%s') # Use double percents to escape.
  98. format_def = ('0000-', '01', '-01', ' 00:', '00', ':00')
  99. if lookup_type == 'quarter':
  100. return (
  101. "CAST(DATE_FORMAT(MAKEDATE(YEAR({field_name}), 1) + "
  102. "INTERVAL QUARTER({field_name}) QUARTER - " +
  103. "INTERVAL 1 QUARTER, '%%Y-%%m-01 00:00:00') AS DATETIME)"
  104. ).format(field_name=field_name)
  105. if lookup_type == 'week':
  106. return (
  107. "CAST(DATE_FORMAT(DATE_SUB({field_name}, "
  108. "INTERVAL WEEKDAY({field_name}) DAY), "
  109. "'%%Y-%%m-%%d 00:00:00') AS DATETIME)"
  110. ).format(field_name=field_name)
  111. try:
  112. i = fields.index(lookup_type) + 1
  113. except ValueError:
  114. sql = field_name
  115. else:
  116. format_str = ''.join(format[:i] + format_def[i:])
  117. sql = "CAST(DATE_FORMAT(%s, '%s') AS DATETIME)" % (field_name, format_str)
  118. return sql
  119. def time_trunc_sql(self, lookup_type, field_name, tzname=None):
  120. field_name = self._convert_field_to_tz(field_name, tzname)
  121. fields = {
  122. 'hour': '%%H:00:00',
  123. 'minute': '%%H:%%i:00',
  124. 'second': '%%H:%%i:%%s',
  125. } # Use double percents to escape.
  126. if lookup_type in fields:
  127. format_str = fields[lookup_type]
  128. return "CAST(DATE_FORMAT(%s, '%s') AS TIME)" % (field_name, format_str)
  129. else:
  130. return "TIME(%s)" % (field_name)
  131. def fetch_returned_insert_rows(self, cursor):
  132. """
  133. Given a cursor object that has just performed an INSERT...RETURNING
  134. statement into a table, return the tuple of returned data.
  135. """
  136. return cursor.fetchall()
  137. def format_for_duration_arithmetic(self, sql):
  138. return 'INTERVAL %s MICROSECOND' % sql
  139. def force_no_ordering(self):
  140. """
  141. "ORDER BY NULL" prevents MySQL from implicitly ordering by grouped
  142. columns. If no ordering would otherwise be applied, we don't want any
  143. implicit sorting going on.
  144. """
  145. return [(None, ("NULL", [], False))]
  146. def adapt_decimalfield_value(self, value, max_digits=None, decimal_places=None):
  147. return value
  148. def last_executed_query(self, cursor, sql, params):
  149. # With MySQLdb, cursor objects have an (undocumented) "_executed"
  150. # attribute where the exact query sent to the database is saved.
  151. # See MySQLdb/cursors.py in the source distribution.
  152. # MySQLdb returns string, PyMySQL bytes.
  153. return force_str(getattr(cursor, '_executed', None), errors='replace')
  154. def no_limit_value(self):
  155. # 2**64 - 1, as recommended by the MySQL documentation
  156. return 18446744073709551615
  157. def quote_name(self, name):
  158. if name.startswith("`") and name.endswith("`"):
  159. return name # Quoting once is enough.
  160. return "`%s`" % name
  161. def return_insert_columns(self, fields):
  162. # MySQL and MariaDB < 10.5.0 don't support an INSERT...RETURNING
  163. # statement.
  164. if not fields:
  165. return '', ()
  166. columns = [
  167. '%s.%s' % (
  168. self.quote_name(field.model._meta.db_table),
  169. self.quote_name(field.column),
  170. ) for field in fields
  171. ]
  172. return 'RETURNING %s' % ', '.join(columns), ()
  173. def sql_flush(self, style, tables, *, reset_sequences=False, allow_cascade=False):
  174. if not tables:
  175. return []
  176. sql = ['SET FOREIGN_KEY_CHECKS = 0;']
  177. if reset_sequences:
  178. # It's faster to TRUNCATE tables that require a sequence reset
  179. # since ALTER TABLE AUTO_INCREMENT is slower than TRUNCATE.
  180. sql.extend(
  181. '%s %s;' % (
  182. style.SQL_KEYWORD('TRUNCATE'),
  183. style.SQL_FIELD(self.quote_name(table_name)),
  184. ) for table_name in tables
  185. )
  186. else:
  187. # Otherwise issue a simple DELETE since it's faster than TRUNCATE
  188. # and preserves sequences.
  189. sql.extend(
  190. '%s %s %s;' % (
  191. style.SQL_KEYWORD('DELETE'),
  192. style.SQL_KEYWORD('FROM'),
  193. style.SQL_FIELD(self.quote_name(table_name)),
  194. ) for table_name in tables
  195. )
  196. sql.append('SET FOREIGN_KEY_CHECKS = 1;')
  197. return sql
  198. def sequence_reset_by_name_sql(self, style, sequences):
  199. return [
  200. '%s %s %s %s = 1;' % (
  201. style.SQL_KEYWORD('ALTER'),
  202. style.SQL_KEYWORD('TABLE'),
  203. style.SQL_FIELD(self.quote_name(sequence_info['table'])),
  204. style.SQL_FIELD('AUTO_INCREMENT'),
  205. ) for sequence_info in sequences
  206. ]
  207. def validate_autopk_value(self, value):
  208. # Zero in AUTO_INCREMENT field does not work without the
  209. # NO_AUTO_VALUE_ON_ZERO SQL mode.
  210. if value == 0 and not self.connection.features.allows_auto_pk_0:
  211. raise ValueError('The database backend does not accept 0 as a '
  212. 'value for AutoField.')
  213. return value
  214. def adapt_datetimefield_value(self, value):
  215. if value is None:
  216. return None
  217. # Expression values are adapted by the database.
  218. if hasattr(value, 'resolve_expression'):
  219. return value
  220. # MySQL doesn't support tz-aware datetimes
  221. if timezone.is_aware(value):
  222. if settings.USE_TZ:
  223. value = timezone.make_naive(value, self.connection.timezone)
  224. else:
  225. raise ValueError("MySQL backend does not support timezone-aware datetimes when USE_TZ is False.")
  226. return str(value)
  227. def adapt_timefield_value(self, value):
  228. if value is None:
  229. return None
  230. # Expression values are adapted by the database.
  231. if hasattr(value, 'resolve_expression'):
  232. return value
  233. # MySQL doesn't support tz-aware times
  234. if timezone.is_aware(value):
  235. raise ValueError("MySQL backend does not support timezone-aware times.")
  236. return str(value)
  237. def max_name_length(self):
  238. return 64
  239. def pk_default_value(self):
  240. return 'NULL'
  241. def bulk_insert_sql(self, fields, placeholder_rows):
  242. placeholder_rows_sql = (", ".join(row) for row in placeholder_rows)
  243. values_sql = ", ".join("(%s)" % sql for sql in placeholder_rows_sql)
  244. return "VALUES " + values_sql
  245. def combine_expression(self, connector, sub_expressions):
  246. if connector == '^':
  247. return 'POW(%s)' % ','.join(sub_expressions)
  248. # Convert the result to a signed integer since MySQL's binary operators
  249. # return an unsigned integer.
  250. elif connector in ('&', '|', '<<', '#'):
  251. connector = '^' if connector == '#' else connector
  252. return 'CONVERT(%s, SIGNED)' % connector.join(sub_expressions)
  253. elif connector == '>>':
  254. lhs, rhs = sub_expressions
  255. return 'FLOOR(%(lhs)s / POW(2, %(rhs)s))' % {'lhs': lhs, 'rhs': rhs}
  256. return super().combine_expression(connector, sub_expressions)
  257. def get_db_converters(self, expression):
  258. converters = super().get_db_converters(expression)
  259. internal_type = expression.output_field.get_internal_type()
  260. if internal_type in ['BooleanField', 'NullBooleanField']:
  261. converters.append(self.convert_booleanfield_value)
  262. elif internal_type == 'DateTimeField':
  263. if settings.USE_TZ:
  264. converters.append(self.convert_datetimefield_value)
  265. elif internal_type == 'UUIDField':
  266. converters.append(self.convert_uuidfield_value)
  267. return converters
  268. def convert_booleanfield_value(self, value, expression, connection):
  269. if value in (0, 1):
  270. value = bool(value)
  271. return value
  272. def convert_datetimefield_value(self, value, expression, connection):
  273. if value is not None:
  274. value = timezone.make_aware(value, self.connection.timezone)
  275. return value
  276. def convert_uuidfield_value(self, value, expression, connection):
  277. if value is not None:
  278. value = uuid.UUID(value)
  279. return value
  280. def binary_placeholder_sql(self, value):
  281. return '_binary %s' if value is not None and not hasattr(value, 'as_sql') else '%s'
  282. def subtract_temporals(self, internal_type, lhs, rhs):
  283. lhs_sql, lhs_params = lhs
  284. rhs_sql, rhs_params = rhs
  285. if internal_type == 'TimeField':
  286. if self.connection.mysql_is_mariadb:
  287. # MariaDB includes the microsecond component in TIME_TO_SEC as
  288. # a decimal. MySQL returns an integer without microseconds.
  289. return 'CAST((TIME_TO_SEC(%(lhs)s) - TIME_TO_SEC(%(rhs)s)) * 1000000 AS SIGNED)' % {
  290. 'lhs': lhs_sql, 'rhs': rhs_sql
  291. }, (*lhs_params, *rhs_params)
  292. return (
  293. "((TIME_TO_SEC(%(lhs)s) * 1000000 + MICROSECOND(%(lhs)s)) -"
  294. " (TIME_TO_SEC(%(rhs)s) * 1000000 + MICROSECOND(%(rhs)s)))"
  295. ) % {'lhs': lhs_sql, 'rhs': rhs_sql}, tuple(lhs_params) * 2 + tuple(rhs_params) * 2
  296. params = (*rhs_params, *lhs_params)
  297. return "TIMESTAMPDIFF(MICROSECOND, %s, %s)" % (rhs_sql, lhs_sql), params
  298. def explain_query_prefix(self, format=None, **options):
  299. # Alias MySQL's TRADITIONAL to TEXT for consistency with other backends.
  300. if format and format.upper() == 'TEXT':
  301. format = 'TRADITIONAL'
  302. elif not format and 'TREE' in self.connection.features.supported_explain_formats:
  303. # Use TREE by default (if supported) as it's more informative.
  304. format = 'TREE'
  305. analyze = options.pop('analyze', False)
  306. prefix = super().explain_query_prefix(format, **options)
  307. if analyze and self.connection.features.supports_explain_analyze:
  308. # MariaDB uses ANALYZE instead of EXPLAIN ANALYZE.
  309. prefix = 'ANALYZE' if self.connection.mysql_is_mariadb else prefix + ' ANALYZE'
  310. if format and not (analyze and not self.connection.mysql_is_mariadb):
  311. # Only MariaDB supports the analyze option with formats.
  312. prefix += ' FORMAT=%s' % format
  313. return prefix
  314. def regex_lookup(self, lookup_type):
  315. # REGEXP BINARY doesn't work correctly in MySQL 8+ and REGEXP_LIKE
  316. # doesn't exist in MySQL 5.x or in MariaDB.
  317. if self.connection.mysql_version < (8, 0, 0) or self.connection.mysql_is_mariadb:
  318. if lookup_type == 'regex':
  319. return '%s REGEXP BINARY %s'
  320. return '%s REGEXP %s'
  321. match_option = 'c' if lookup_type == 'regex' else 'i'
  322. return "REGEXP_LIKE(%%s, %%s, '%s')" % match_option
  323. def insert_statement(self, ignore_conflicts=False):
  324. return 'INSERT IGNORE INTO' if ignore_conflicts else super().insert_statement(ignore_conflicts)
  325. def lookup_cast(self, lookup_type, internal_type=None):
  326. lookup = '%s'
  327. if internal_type == 'JSONField':
  328. if self.connection.mysql_is_mariadb or lookup_type in (
  329. 'iexact', 'contains', 'icontains', 'startswith', 'istartswith',
  330. 'endswith', 'iendswith', 'regex', 'iregex',
  331. ):
  332. lookup = 'JSON_UNQUOTE(%s)'
  333. return lookup