You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

introspection.py 11KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276
  1. from collections import namedtuple
  2. import cx_Oracle
  3. from django.db import models
  4. from django.db.backends.base.introspection import (
  5. BaseDatabaseIntrospection, FieldInfo as BaseFieldInfo, TableInfo,
  6. )
  7. FieldInfo = namedtuple('FieldInfo', BaseFieldInfo._fields + ('is_autofield',))
  8. class DatabaseIntrospection(BaseDatabaseIntrospection):
  9. # Maps type objects to Django Field types.
  10. data_types_reverse = {
  11. cx_Oracle.BLOB: 'BinaryField',
  12. cx_Oracle.CLOB: 'TextField',
  13. cx_Oracle.DATETIME: 'DateField',
  14. cx_Oracle.FIXED_CHAR: 'CharField',
  15. cx_Oracle.FIXED_NCHAR: 'CharField',
  16. cx_Oracle.INTERVAL: 'DurationField',
  17. cx_Oracle.NATIVE_FLOAT: 'FloatField',
  18. cx_Oracle.NCHAR: 'CharField',
  19. cx_Oracle.NCLOB: 'TextField',
  20. cx_Oracle.NUMBER: 'DecimalField',
  21. cx_Oracle.STRING: 'CharField',
  22. cx_Oracle.TIMESTAMP: 'DateTimeField',
  23. }
  24. cache_bust_counter = 1
  25. def get_field_type(self, data_type, description):
  26. if data_type == cx_Oracle.NUMBER:
  27. precision, scale = description[4:6]
  28. if scale == 0:
  29. if precision > 11:
  30. return 'BigAutoField' if description.is_autofield else 'BigIntegerField'
  31. elif precision == 1:
  32. return 'BooleanField'
  33. elif description.is_autofield:
  34. return 'AutoField'
  35. else:
  36. return 'IntegerField'
  37. elif scale == -127:
  38. return 'FloatField'
  39. return super().get_field_type(data_type, description)
  40. def get_table_list(self, cursor):
  41. """Return a list of table and view names in the current database."""
  42. cursor.execute("""
  43. SELECT table_name, 't'
  44. FROM user_tables
  45. WHERE
  46. NOT EXISTS (
  47. SELECT 1
  48. FROM user_mviews
  49. WHERE user_mviews.mview_name = user_tables.table_name
  50. )
  51. UNION ALL
  52. SELECT view_name, 'v' FROM user_views
  53. UNION ALL
  54. SELECT mview_name, 'v' FROM user_mviews
  55. """)
  56. return [TableInfo(self.identifier_converter(row[0]), row[1]) for row in cursor.fetchall()]
  57. def get_table_description(self, cursor, table_name):
  58. """
  59. Return a description of the table with the DB-API cursor.description
  60. interface.
  61. """
  62. # user_tab_columns gives data default for columns
  63. cursor.execute("""
  64. SELECT
  65. column_name,
  66. data_default,
  67. CASE
  68. WHEN char_used IS NULL THEN data_length
  69. ELSE char_length
  70. END as internal_size,
  71. CASE
  72. WHEN identity_column = 'YES' THEN 1
  73. ELSE 0
  74. END as is_autofield
  75. FROM user_tab_cols
  76. WHERE table_name = UPPER(%s)""", [table_name])
  77. field_map = {
  78. column: (internal_size, default if default != 'NULL' else None, is_autofield)
  79. for column, default, internal_size, is_autofield in cursor.fetchall()
  80. }
  81. self.cache_bust_counter += 1
  82. cursor.execute("SELECT * FROM {} WHERE ROWNUM < 2 AND {} > 0".format(
  83. self.connection.ops.quote_name(table_name),
  84. self.cache_bust_counter))
  85. description = []
  86. for desc in cursor.description:
  87. name = desc[0]
  88. internal_size, default, is_autofield = field_map[name]
  89. name = name % {} # cx_Oracle, for some reason, doubles percent signs.
  90. description.append(FieldInfo(
  91. self.identifier_converter(name), *desc[1:3], internal_size, desc[4] or 0,
  92. desc[5] or 0, *desc[6:], default, is_autofield,
  93. ))
  94. return description
  95. def identifier_converter(self, name):
  96. """Identifier comparison is case insensitive under Oracle."""
  97. return name.lower()
  98. def get_sequences(self, cursor, table_name, table_fields=()):
  99. cursor.execute("""
  100. SELECT
  101. user_tab_identity_cols.sequence_name,
  102. user_tab_identity_cols.column_name
  103. FROM
  104. user_tab_identity_cols,
  105. user_constraints,
  106. user_cons_columns cols
  107. WHERE
  108. user_constraints.constraint_name = cols.constraint_name
  109. AND user_constraints.table_name = user_tab_identity_cols.table_name
  110. AND cols.column_name = user_tab_identity_cols.column_name
  111. AND user_constraints.constraint_type = 'P'
  112. AND user_tab_identity_cols.table_name = UPPER(%s)
  113. """, [table_name])
  114. # Oracle allows only one identity column per table.
  115. row = cursor.fetchone()
  116. if row:
  117. return [{
  118. 'name': self.identifier_converter(row[0]),
  119. 'table': self.identifier_converter(table_name),
  120. 'column': self.identifier_converter(row[1]),
  121. }]
  122. # To keep backward compatibility for AutoFields that aren't Oracle
  123. # identity columns.
  124. for f in table_fields:
  125. if isinstance(f, models.AutoField):
  126. return [{'table': table_name, 'column': f.column}]
  127. return []
  128. def get_relations(self, cursor, table_name):
  129. """
  130. Return a dictionary of {field_name: (field_name_other_table, other_table)}
  131. representing all relationships to the given table.
  132. """
  133. table_name = table_name.upper()
  134. cursor.execute("""
  135. SELECT ca.column_name, cb.table_name, cb.column_name
  136. FROM user_constraints, USER_CONS_COLUMNS ca, USER_CONS_COLUMNS cb
  137. WHERE user_constraints.table_name = %s AND
  138. user_constraints.constraint_name = ca.constraint_name AND
  139. user_constraints.r_constraint_name = cb.constraint_name AND
  140. ca.position = cb.position""", [table_name])
  141. return {
  142. self.identifier_converter(field_name): (
  143. self.identifier_converter(rel_field_name),
  144. self.identifier_converter(rel_table_name),
  145. ) for field_name, rel_table_name, rel_field_name in cursor.fetchall()
  146. }
  147. def get_key_columns(self, cursor, table_name):
  148. cursor.execute("""
  149. SELECT ccol.column_name, rcol.table_name AS referenced_table, rcol.column_name AS referenced_column
  150. FROM user_constraints c
  151. JOIN user_cons_columns ccol
  152. ON ccol.constraint_name = c.constraint_name
  153. JOIN user_cons_columns rcol
  154. ON rcol.constraint_name = c.r_constraint_name
  155. WHERE c.table_name = %s AND c.constraint_type = 'R'""", [table_name.upper()])
  156. return [
  157. tuple(self.identifier_converter(cell) for cell in row)
  158. for row in cursor.fetchall()
  159. ]
  160. def get_constraints(self, cursor, table_name):
  161. """
  162. Retrieve any constraints or keys (unique, pk, fk, check, index) across
  163. one or more columns.
  164. """
  165. constraints = {}
  166. # Loop over the constraints, getting PKs, uniques, and checks
  167. cursor.execute("""
  168. SELECT
  169. user_constraints.constraint_name,
  170. LISTAGG(LOWER(cols.column_name), ',') WITHIN GROUP (ORDER BY cols.position),
  171. CASE user_constraints.constraint_type
  172. WHEN 'P' THEN 1
  173. ELSE 0
  174. END AS is_primary_key,
  175. CASE
  176. WHEN user_constraints.constraint_type IN ('P', 'U') THEN 1
  177. ELSE 0
  178. END AS is_unique,
  179. CASE user_constraints.constraint_type
  180. WHEN 'C' THEN 1
  181. ELSE 0
  182. END AS is_check_constraint
  183. FROM
  184. user_constraints
  185. LEFT OUTER JOIN
  186. user_cons_columns cols ON user_constraints.constraint_name = cols.constraint_name
  187. WHERE
  188. user_constraints.constraint_type = ANY('P', 'U', 'C')
  189. AND user_constraints.table_name = UPPER(%s)
  190. GROUP BY user_constraints.constraint_name, user_constraints.constraint_type
  191. """, [table_name])
  192. for constraint, columns, pk, unique, check in cursor.fetchall():
  193. constraint = self.identifier_converter(constraint)
  194. constraints[constraint] = {
  195. 'columns': columns.split(','),
  196. 'primary_key': pk,
  197. 'unique': unique,
  198. 'foreign_key': None,
  199. 'check': check,
  200. 'index': unique, # All uniques come with an index
  201. }
  202. # Foreign key constraints
  203. cursor.execute("""
  204. SELECT
  205. cons.constraint_name,
  206. LISTAGG(LOWER(cols.column_name), ',') WITHIN GROUP (ORDER BY cols.position),
  207. LOWER(rcols.table_name),
  208. LOWER(rcols.column_name)
  209. FROM
  210. user_constraints cons
  211. INNER JOIN
  212. user_cons_columns rcols ON rcols.constraint_name = cons.r_constraint_name AND rcols.position = 1
  213. LEFT OUTER JOIN
  214. user_cons_columns cols ON cons.constraint_name = cols.constraint_name
  215. WHERE
  216. cons.constraint_type = 'R' AND
  217. cons.table_name = UPPER(%s)
  218. GROUP BY cons.constraint_name, rcols.table_name, rcols.column_name
  219. """, [table_name])
  220. for constraint, columns, other_table, other_column in cursor.fetchall():
  221. constraint = self.identifier_converter(constraint)
  222. constraints[constraint] = {
  223. 'primary_key': False,
  224. 'unique': False,
  225. 'foreign_key': (other_table, other_column),
  226. 'check': False,
  227. 'index': False,
  228. 'columns': columns.split(','),
  229. }
  230. # Now get indexes
  231. cursor.execute("""
  232. SELECT
  233. ind.index_name,
  234. LOWER(ind.index_type),
  235. LISTAGG(LOWER(cols.column_name), ',') WITHIN GROUP (ORDER BY cols.column_position),
  236. LISTAGG(cols.descend, ',') WITHIN GROUP (ORDER BY cols.column_position)
  237. FROM
  238. user_ind_columns cols, user_indexes ind
  239. WHERE
  240. cols.table_name = UPPER(%s) AND
  241. NOT EXISTS (
  242. SELECT 1
  243. FROM user_constraints cons
  244. WHERE ind.index_name = cons.index_name
  245. ) AND cols.index_name = ind.index_name
  246. GROUP BY ind.index_name, ind.index_type
  247. """, [table_name])
  248. for constraint, type_, columns, orders in cursor.fetchall():
  249. constraint = self.identifier_converter(constraint)
  250. constraints[constraint] = {
  251. 'primary_key': False,
  252. 'unique': False,
  253. 'foreign_key': None,
  254. 'check': False,
  255. 'index': True,
  256. 'type': 'idx' if type_ == 'normal' else type_,
  257. 'columns': columns.split(','),
  258. 'orders': orders.split(','),
  259. }
  260. return constraints