/bangkokhotel/lib/python2.5/site-packages/south/db/oracle.py

https://bitbucket.org/luisrodriguez/bangkokhotel · Python · 299 lines · 210 code · 44 blank · 45 comment · 43 complexity · a121643f1aed9bf98887c0ec44a7d755 MD5 · raw file

  1. import os.path
  2. import sys
  3. import re
  4. import warnings
  5. import cx_Oracle
  6. from django.db import connection, models
  7. from django.db.backends.util import truncate_name
  8. from django.core.management.color import no_style
  9. from django.db.models.fields import NOT_PROVIDED
  10. from django.db.utils import DatabaseError
  11. # In revision r16016 function get_sequence_name has been transformed into
  12. # method of DatabaseOperations class. To make code backward-compatible we
  13. # need to handle both situations.
  14. try:
  15. from django.db.backends.oracle.base import get_sequence_name\
  16. as original_get_sequence_name
  17. except ImportError:
  18. original_get_sequence_name = None
  19. from south.db import generic
  20. warnings.warn("! WARNING: South's Oracle support is still alpha. "
  21. "Be wary of possible bugs.")
  22. class DatabaseOperations(generic.DatabaseOperations):
  23. """
  24. Oracle implementation of database operations.
  25. """
  26. backend_name = 'oracle'
  27. alter_string_set_type = 'ALTER TABLE %(table_name)s MODIFY %(column)s %(type)s %(nullity)s;'
  28. alter_string_set_default = 'ALTER TABLE %(table_name)s MODIFY %(column)s DEFAULT %(default)s;'
  29. add_column_string = 'ALTER TABLE %s ADD %s;'
  30. delete_column_string = 'ALTER TABLE %s DROP COLUMN %s;'
  31. add_constraint_string = 'ALTER TABLE %(table_name)s ADD CONSTRAINT %(constraint)s %(clause)s'
  32. allows_combined_alters = False
  33. has_booleans = False
  34. constraints_dict = {
  35. 'P': 'PRIMARY KEY',
  36. 'U': 'UNIQUE',
  37. 'C': 'CHECK',
  38. 'R': 'FOREIGN KEY'
  39. }
  40. def get_sequence_name(self, table_name):
  41. if original_get_sequence_name is None:
  42. return self._get_connection().ops._get_sequence_name(table_name)
  43. else:
  44. return original_get_sequence_name(table_name)
  45. #TODO: This will cause very obscure bugs if anyone uses a column name or string value
  46. # that looks like a column definition (with 'CHECK', 'DEFAULT' and/or 'NULL' in it)
  47. # e.g. "CHECK MATE" varchar(10) DEFAULT 'NULL'
  48. def adj_column_sql(self, col):
  49. # Syntax fixes -- Oracle is picky about clause order
  50. col = re.sub('(?P<constr>CHECK \(.*\))(?P<any>.*)(?P<default>DEFAULT \d+)',
  51. lambda mo: '%s %s%s'%(mo.group('default'), mo.group('constr'), mo.group('any')), col) #syntax fix for boolean/integer field only
  52. col = re.sub('(?P<not_null>(NOT )?NULL) (?P<misc>(.* )?)(?P<default>DEFAULT.+)',
  53. lambda mo: '%s %s %s'%(mo.group('default'),mo.group('not_null'),mo.group('misc') or ''), col) #fix order of NULL/NOT NULL and DEFAULT
  54. return col
  55. def check_meta(self, table_name):
  56. return table_name in [ m._meta.db_table for m in models.get_models() ] #caching provided by Django
  57. def normalize_name(self, name):
  58. """
  59. Get the properly shortened and uppercased identifier as returned by quote_name(), but without the actual quotes.
  60. """
  61. nn = self.quote_name(name)
  62. if nn[0] == '"' and nn[-1] == '"':
  63. nn = nn[1:-1]
  64. return nn
  65. @generic.invalidate_table_constraints
  66. def create_table(self, table_name, fields):
  67. qn = self.quote_name(table_name)
  68. columns = []
  69. autoinc_sql = ''
  70. for field_name, field in fields:
  71. col = self.column_sql(table_name, field_name, field)
  72. if not col:
  73. continue
  74. col = self.adj_column_sql(col)
  75. columns.append(col)
  76. if isinstance(field, models.AutoField):
  77. autoinc_sql = connection.ops.autoinc_sql(table_name, field_name)
  78. sql = 'CREATE TABLE %s (%s);' % (qn, ', '.join([col for col in columns]))
  79. self.execute(sql)
  80. if autoinc_sql:
  81. self.execute(autoinc_sql[0])
  82. self.execute(autoinc_sql[1])
  83. @generic.invalidate_table_constraints
  84. def delete_table(self, table_name, cascade=True):
  85. qn = self.quote_name(table_name)
  86. # Note: PURGE is not valid syntax for Oracle 9i (it was added in 10)
  87. if cascade:
  88. self.execute('DROP TABLE %s CASCADE CONSTRAINTS;' % qn)
  89. else:
  90. self.execute('DROP TABLE %s;' % qn)
  91. # If the table has an AutoField a sequence was created.
  92. sequence_sql = """
  93. DECLARE
  94. i INTEGER;
  95. BEGIN
  96. SELECT COUNT(*) INTO i FROM USER_CATALOG
  97. WHERE TABLE_NAME = '%(sq_name)s' AND TABLE_TYPE = 'SEQUENCE';
  98. IF i = 1 THEN
  99. EXECUTE IMMEDIATE 'DROP SEQUENCE "%(sq_name)s"';
  100. END IF;
  101. END;
  102. /""" % {'sq_name': self.get_sequence_name(table_name)}
  103. self.execute(sequence_sql)
  104. @generic.invalidate_table_constraints
  105. def alter_column(self, table_name, name, field, explicit_name=True):
  106. if self.dry_run:
  107. if self.debug:
  108. print ' - no dry run output for alter_column() due to dynamic DDL, sorry'
  109. return
  110. qn = self.quote_name(table_name)
  111. # hook for the field to do any resolution prior to it's attributes being queried
  112. if hasattr(field, 'south_init'):
  113. field.south_init()
  114. field = self._field_sanity(field)
  115. # Add _id or whatever if we need to
  116. field.set_attributes_from_name(name)
  117. if not explicit_name:
  118. name = field.column
  119. qn_col = self.quote_name(name)
  120. # First, change the type
  121. # This will actually also add any CHECK constraints needed,
  122. # since e.g. 'type' for a BooleanField is 'NUMBER(1) CHECK (%(qn_column)s IN (0,1))'
  123. params = {
  124. 'table_name':qn,
  125. 'column': qn_col,
  126. 'type': self._db_type_for_alter_column(field),
  127. 'nullity': 'NOT NULL',
  128. 'default': 'NULL'
  129. }
  130. if field.null:
  131. params['nullity'] = 'NULL'
  132. if not field.null and field.has_default():
  133. params['default'] = self._default_value_workaround(field.get_default())
  134. sql_templates = [
  135. (self.alter_string_set_type, params),
  136. (self.alter_string_set_default, params.copy()),
  137. ]
  138. # drop CHECK constraints. Make sure this is executed before the ALTER TABLE statements
  139. # generated above, since those statements recreate the constraints we delete here.
  140. check_constraints = self._constraints_affecting_columns(table_name, [name], "CHECK")
  141. for constraint in check_constraints:
  142. self.execute(self.delete_check_sql % {
  143. 'table': self.quote_name(table_name),
  144. 'constraint': self.quote_name(constraint),
  145. })
  146. for sql_template, params in sql_templates:
  147. try:
  148. self.execute(sql_template % params)
  149. except DatabaseError, exc:
  150. description = str(exc)
  151. # Oracle complains if a column is already NULL/NOT NULL
  152. if 'ORA-01442' in description or 'ORA-01451' in description:
  153. # so we just drop NULL/NOT NULL part from target sql and retry
  154. params['nullity'] = ''
  155. sql = sql_template % params
  156. self.execute(sql)
  157. # Oracle also has issues if we try to change a regular column
  158. # to a LOB or vice versa (also REF, object, VARRAY or nested
  159. # table, but these don't come up much in Django apps)
  160. elif 'ORA-22858' in description or 'ORA-22859' in description:
  161. self._alter_column_lob_workaround(table_name, name, field)
  162. else:
  163. raise
  164. def _alter_column_lob_workaround(self, table_name, name, field):
  165. """
  166. Oracle refuses to change a column type from/to LOB to/from a regular
  167. column. In Django, this shows up when the field is changed from/to
  168. a TextField.
  169. What we need to do instead is:
  170. - Rename the original column
  171. - Add the desired field as new
  172. - Update the table to transfer values from old to new
  173. - Drop old column
  174. """
  175. renamed = self._generate_temp_name(name)
  176. self.rename_column(table_name, name, renamed)
  177. self.add_column(table_name, name, field, keep_default=False)
  178. self.execute("UPDATE %s set %s=%s" % (
  179. self.quote_name(table_name),
  180. self.quote_name(name),
  181. self.quote_name(renamed),
  182. ))
  183. self.delete_column(table_name, renamed)
  184. def _generate_temp_name(self, for_name):
  185. suffix = hex(hash(for_name)).upper()[1:]
  186. return self.normalize_name(for_name + "_" + suffix)
  187. @generic.copy_column_constraints #TODO: Appears to be nulled by the delete decorator below...
  188. @generic.delete_column_constraints
  189. def rename_column(self, table_name, old, new):
  190. if old == new:
  191. # Short-circuit out
  192. return []
  193. self.execute('ALTER TABLE %s RENAME COLUMN %s TO %s;' % (
  194. self.quote_name(table_name),
  195. self.quote_name(old),
  196. self.quote_name(new),
  197. ))
  198. @generic.invalidate_table_constraints
  199. def add_column(self, table_name, name, field, keep_default=True):
  200. sql = self.column_sql(table_name, name, field)
  201. sql = self.adj_column_sql(sql)
  202. if sql:
  203. params = (
  204. self.quote_name(table_name),
  205. sql
  206. )
  207. sql = self.add_column_string % params
  208. self.execute(sql)
  209. # Now, drop the default if we need to
  210. if not keep_default and field.default is not None:
  211. field.default = NOT_PROVIDED
  212. self.alter_column(table_name, name, field, explicit_name=False)
  213. def delete_column(self, table_name, name):
  214. return super(DatabaseOperations, self).delete_column(self.quote_name(table_name), name)
  215. def lookup_constraint(self, db_name, table_name, column_name=None):
  216. if column_name:
  217. # Column names in the constraint cache come from the database,
  218. # make sure we use the properly shortened/uppercased version
  219. # for lookup.
  220. column_name = self.normalize_name(column_name)
  221. return super(DatabaseOperations, self).lookup_constraint(db_name, table_name, column_name)
  222. def _constraints_affecting_columns(self, table_name, columns, type="UNIQUE"):
  223. if columns:
  224. columns = [self.normalize_name(c) for c in columns]
  225. return super(DatabaseOperations, self)._constraints_affecting_columns(table_name, columns, type)
  226. def _field_sanity(self, field):
  227. """
  228. This particular override stops us sending DEFAULTs for BooleanField.
  229. """
  230. if isinstance(field, models.BooleanField) and field.has_default():
  231. field.default = int(field.to_python(field.get_default()))
  232. return field
  233. def _default_value_workaround(self, value):
  234. from datetime import date,time,datetime
  235. if isinstance(value, (date,time,datetime)):
  236. return "'%s'" % value
  237. else:
  238. return super(DatabaseOperations, self)._default_value_workaround(value)
  239. def _fill_constraint_cache(self, db_name, table_name):
  240. self._constraint_cache.setdefault(db_name, {})
  241. self._constraint_cache[db_name][table_name] = {}
  242. rows = self.execute("""
  243. SELECT user_cons_columns.constraint_name,
  244. user_cons_columns.column_name,
  245. user_constraints.constraint_type
  246. FROM user_constraints
  247. JOIN user_cons_columns ON
  248. user_constraints.table_name = user_cons_columns.table_name AND
  249. user_constraints.constraint_name = user_cons_columns.constraint_name
  250. WHERE user_constraints.table_name = '%s'
  251. """ % self.normalize_name(table_name))
  252. for constraint, column, kind in rows:
  253. self._constraint_cache[db_name][table_name].setdefault(column, set())
  254. self._constraint_cache[db_name][table_name][column].add((self.constraints_dict[kind], constraint))
  255. return