Development of an internal social media platform with personalised dashboards for students
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 10KB

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