-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
sqldiff.py
1403 lines (1205 loc) · 62.4 KB
/
sqldiff.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# -*- coding: utf-8 -*-
"""
sqldiff.py - Prints the (approximated) difference between models and database
TODO:
- better support for relations
- better support for constraints (mainly postgresql?)
- support for table spaces with postgresql
- when a table is not managed (meta.managed==False) then only do a one-way
sqldiff ? show differences from db->table but not the other way around since
it's not managed.
KNOWN ISSUES:
- MySQL has by far the most problems with introspection. Please be
carefull when using MySQL with sqldiff.
- Booleans are reported back as Integers, so there's no way to know if
there was a real change.
- Varchar sizes are reported back without unicode support so their size
may change in comparison to the real length of the varchar.
- Some of the 'fixes' to counter these problems might create false
positives or false negatives.
"""
import importlib
import sys
import argparse
from typing import Dict, Union, Callable, Optional # NOQA
from django.apps import apps
from django.core.management import BaseCommand, CommandError
from django.core.management.base import OutputWrapper
from django.core.management.color import no_style
from django.db import connection, transaction, models
from django.db.models import UniqueConstraint
from django.db.models.fields import AutoField, IntegerField
from django.db.models.options import normalize_together
from django_extensions.management.utils import signalcommand
ORDERING_FIELD = IntegerField('_order', null=True)
def flatten(lst, ltypes=(list, tuple)):
ltype = type(lst)
lst = list(lst)
i = 0
while i < len(lst):
while isinstance(lst[i], ltypes):
if not lst[i]:
lst.pop(i)
i -= 1
break
else:
lst[i:i + 1] = lst[i]
i += 1
return ltype(lst)
def all_local_fields(meta):
all_fields = []
if meta.proxy:
for parent in meta.parents:
all_fields.extend(all_local_fields(parent._meta))
else:
for f in meta.local_fields:
col_type = f.db_type(connection=connection)
if col_type is None:
continue
all_fields.append(f)
return all_fields
class SQLDiff:
DATA_TYPES_REVERSE_OVERRIDE = {} # type: Dict[int, Union[str, Callable]]
IGNORE_MISSING_TABLES = [
"django_migrations",
]
DIFF_TYPES = [
'error',
'comment',
'table-missing-in-db',
'table-missing-in-model',
'field-missing-in-db',
'field-missing-in-model',
'fkey-missing-in-db',
'fkey-missing-in-model',
'index-missing-in-db',
'index-missing-in-model',
'unique-missing-in-db',
'unique-missing-in-model',
'field-type-differ',
'field-parameter-differ',
'notnull-differ',
]
DIFF_TEXTS = {
'error': 'error: %(0)s',
'comment': 'comment: %(0)s',
'table-missing-in-db': "table '%(0)s' missing in database",
'table-missing-in-model': "table '%(0)s' missing in models",
'field-missing-in-db': "field '%(1)s' defined in model but missing in database",
'field-missing-in-model': "field '%(1)s' defined in database but missing in model",
'fkey-missing-in-db': "field '%(1)s' FOREIGN KEY defined in model but missing in database",
'fkey-missing-in-model': "field '%(1)s' FOREIGN KEY defined in database but missing in model",
'index-missing-in-db': "field '%(1)s' INDEX named '%(2)s' defined in model but missing in database",
'index-missing-in-model': "field '%(1)s' INDEX defined in database schema but missing in model",
'unique-missing-in-db': "field '%(1)s' UNIQUE named '%(2)s' defined in model but missing in database",
'unique-missing-in-model': "field '%(1)s' UNIQUE defined in database schema but missing in model",
'field-type-differ': "field '%(1)s' not of same type: db='%(3)s', model='%(2)s'",
'field-parameter-differ': "field '%(1)s' parameters differ: db='%(3)s', model='%(2)s'",
'notnull-differ': "field '%(1)s' null constraint should be '%(2)s' in the database",
}
SQL_FIELD_MISSING_IN_DB = lambda self, style, qn, args: "%s %s\n\t%s %s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('ADD COLUMN'),
style.SQL_FIELD(qn(args[1])),
' '.join(style.SQL_COLTYPE(a) if i == 0 else style.SQL_KEYWORD(a) for i, a in enumerate(args[2:]))
)
SQL_FIELD_MISSING_IN_MODEL = lambda self, style, qn, args: "%s %s\n\t%s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('DROP COLUMN'),
style.SQL_FIELD(qn(args[1]))
)
SQL_FKEY_MISSING_IN_DB = lambda self, style, qn, args: "%s %s\n\t%s %s %s %s %s (%s)%s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('ADD COLUMN'),
style.SQL_FIELD(qn(args[1])),
' '.join(style.SQL_COLTYPE(a) if i == 0 else style.SQL_KEYWORD(a) for i, a in enumerate(args[4:])),
style.SQL_KEYWORD('REFERENCES'),
style.SQL_TABLE(qn(args[2])),
style.SQL_FIELD(qn(args[3])),
connection.ops.deferrable_sql()
)
SQL_INDEX_MISSING_IN_DB = lambda self, style, qn, args: "%s %s\n\t%s %s (%s%s);" % (
style.SQL_KEYWORD('CREATE INDEX'),
style.SQL_TABLE(qn(args[2])),
# style.SQL_TABLE(qn("%s" % '_'.join('_'.join(a) if isinstance(a, (list, tuple)) else a for a in args[0:3] if a))),
style.SQL_KEYWORD('ON'), style.SQL_TABLE(qn(args[0])),
style.SQL_FIELD(', '.join(qn(e) for e in args[1])),
style.SQL_KEYWORD(args[3])
)
SQL_INDEX_MISSING_IN_MODEL = lambda self, style, qn, args: "%s %s;" % (
style.SQL_KEYWORD('DROP INDEX'),
style.SQL_TABLE(qn(args[1]))
)
SQL_UNIQUE_MISSING_IN_DB = lambda self, style, qn, args: "%s %s\n\t%s %s %s (%s);" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('ADD CONSTRAINT'),
style.SQL_TABLE(qn(args[2])),
style.SQL_KEYWORD('UNIQUE'),
style.SQL_FIELD(', '.join(qn(e) for e in args[1]))
)
SQL_UNIQUE_MISSING_IN_MODEL = lambda self, style, qn, args: "%s %s\n\t%s %s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('DROP'),
style.SQL_KEYWORD('CONSTRAINT'),
style.SQL_TABLE(qn(args[1]))
)
SQL_FIELD_TYPE_DIFFER = lambda self, style, qn, args: "%s %s\n\t%s %s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD("MODIFY"),
style.SQL_FIELD(qn(args[1])),
style.SQL_COLTYPE(args[2])
)
SQL_FIELD_PARAMETER_DIFFER = lambda self, style, qn, args: "%s %s\n\t%s %s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD("MODIFY"),
style.SQL_FIELD(qn(args[1])),
style.SQL_COLTYPE(args[2])
)
SQL_NOTNULL_DIFFER = lambda self, style, qn, args: "%s %s\n\t%s %s %s %s;" % (
style.SQL_KEYWORD('ALTER TABLE'),
style.SQL_TABLE(qn(args[0])),
style.SQL_KEYWORD('MODIFY'),
style.SQL_FIELD(qn(args[1])),
style.SQL_KEYWORD(args[2]),
style.SQL_KEYWORD('NOT NULL')
)
SQL_ERROR = lambda self, style, qn, args: style.NOTICE('-- Error: %s' % style.ERROR(args[0]))
SQL_COMMENT = lambda self, style, qn, args: style.NOTICE('-- Comment: %s' % style.SQL_TABLE(args[0]))
SQL_TABLE_MISSING_IN_DB = lambda self, style, qn, args: style.NOTICE('-- Table missing: %s' % args[0])
SQL_TABLE_MISSING_IN_MODEL = lambda self, style, qn, args: style.NOTICE('-- Model missing for table: %s' % args[0])
can_detect_notnull_differ = False
can_detect_unsigned_differ = False
unsigned_suffix = None # type: Optional[str]
def __init__(self, app_models, options, stdout, stderr):
self.has_differences = None
self.app_models = app_models
self.options = options
self.dense = options['dense_output']
self.stdout = stdout
self.stderr = stderr
self.introspection = connection.introspection
self.differences = []
self.unknown_db_fields = {}
self.new_db_fields = set()
self.null = {}
self.unsigned = set()
self.DIFF_SQL = {
'error': self.SQL_ERROR,
'comment': self.SQL_COMMENT,
'table-missing-in-db': self.SQL_TABLE_MISSING_IN_DB,
'table-missing-in-model': self.SQL_TABLE_MISSING_IN_MODEL,
'field-missing-in-db': self.SQL_FIELD_MISSING_IN_DB,
'field-missing-in-model': self.SQL_FIELD_MISSING_IN_MODEL,
'fkey-missing-in-db': self.SQL_FKEY_MISSING_IN_DB,
'fkey-missing-in-model': self.SQL_FIELD_MISSING_IN_MODEL,
'index-missing-in-db': self.SQL_INDEX_MISSING_IN_DB,
'index-missing-in-model': self.SQL_INDEX_MISSING_IN_MODEL,
'unique-missing-in-db': self.SQL_UNIQUE_MISSING_IN_DB,
'unique-missing-in-model': self.SQL_UNIQUE_MISSING_IN_MODEL,
'field-type-differ': self.SQL_FIELD_TYPE_DIFFER,
'field-parameter-differ': self.SQL_FIELD_PARAMETER_DIFFER,
'notnull-differ': self.SQL_NOTNULL_DIFFER,
}
def load(self):
self.cursor = connection.cursor()
self.django_tables = self.introspection.django_table_names(only_existing=self.options['only_existing'])
# TODO: We are losing information about tables which are views here
self.db_tables = [table_info.name for table_info in self.introspection.get_table_list(self.cursor)]
if self.can_detect_notnull_differ:
self.load_null()
if self.can_detect_unsigned_differ:
self.load_unsigned()
def load_null(self):
raise NotImplementedError("load_null functions must be implemented if diff backend has 'can_detect_notnull_differ' set to True")
def load_unsigned(self):
raise NotImplementedError("load_unsigned function must be implemented if diff backend has 'can_detect_unsigned_differ' set to True")
def add_app_model_marker(self, app_label, model_name):
self.differences.append((app_label, model_name, []))
def add_difference(self, diff_type, *args):
assert diff_type in self.DIFF_TYPES, 'Unknown difference type'
self.differences[-1][-1].append((diff_type, args))
def get_data_types_reverse_override(self):
# type: () -> Dict[int, Union[str, Callable]]
return self.DATA_TYPES_REVERSE_OVERRIDE
def format_field_names(self, field_names):
return field_names
def sql_to_dict(self, query, param):
"""
Execute query and return a dict
sql_to_dict(query, param) -> list of dicts
code from snippet at https://www.djangosnippets.org/snippets/1383/
"""
cursor = connection.cursor()
cursor.execute(query, param)
fieldnames = [name[0] for name in cursor.description]
fieldnames = self.format_field_names(fieldnames)
result = []
for row in cursor.fetchall():
rowset = []
for field in zip(fieldnames, row):
rowset.append(field)
result.append(dict(rowset))
return result
def get_field_model_type(self, field):
return field.db_type(connection=connection)
def get_field_db_type_kwargs(self, current_kwargs, description, field=None, table_name=None, reverse_type=None):
return {}
def get_field_db_type(self, description, field=None, table_name=None):
# DB-API cursor.description
# (name, type_code, display_size, internal_size, precision, scale, null_ok) = description
type_code = description[1]
DATA_TYPES_REVERSE_OVERRIDE = self.get_data_types_reverse_override()
if type_code in DATA_TYPES_REVERSE_OVERRIDE:
reverse_type = DATA_TYPES_REVERSE_OVERRIDE[type_code]
else:
try:
reverse_type = self.introspection.get_field_type(type_code, description)
except KeyError:
reverse_type = self.get_field_db_type_lookup(type_code)
if not reverse_type:
# type_code not found in data_types_reverse map
key = (self.differences[-1][:2], description[:2])
if key not in self.unknown_db_fields:
self.unknown_db_fields[key] = 1
self.add_difference('comment', "Unknown database type for field '%s' (%s)" % (description[0], type_code))
return None
if callable(reverse_type):
reverse_type = reverse_type()
kwargs = {}
if isinstance(reverse_type, dict):
kwargs.update(reverse_type['kwargs'])
reverse_type = reverse_type['name']
if type_code == 16946 and field and getattr(field, 'geom_type', None) == 'POINT':
reverse_type = 'django.contrib.gis.db.models.fields.PointField'
if isinstance(reverse_type, tuple):
kwargs.update(reverse_type[1])
reverse_type = reverse_type[0]
if reverse_type == "CharField" and description[3]:
kwargs['max_length'] = description[3]
if reverse_type == "DecimalField":
kwargs['max_digits'] = description[4]
kwargs['decimal_places'] = description[5] and abs(description[5]) or description[5]
if description[6]:
kwargs['blank'] = True
if reverse_type not in ('TextField', 'CharField'):
kwargs['null'] = True
if field and getattr(field, 'geography', False):
kwargs['geography'] = True
if reverse_type == 'GeometryField':
geo_col = description[0]
# Getting a more specific field type and any additional parameters
# from the `get_geometry_type` routine for the spatial backend.
reverse_type, geo_params = self.introspection.get_geometry_type(table_name, geo_col)
if geo_params:
kwargs.update(geo_params)
reverse_type = 'django.contrib.gis.db.models.fields.%s' % reverse_type
extra_kwargs = self.get_field_db_type_kwargs(kwargs, description, field, table_name, reverse_type)
kwargs.update(extra_kwargs)
field_class = self.get_field_class(reverse_type)
field_db_type = field_class(**kwargs).db_type(connection=connection)
tablespace = field.db_tablespace
if not tablespace:
tablespace = "public"
if (tablespace, table_name, field.column) in self.unsigned and self.unsigned_suffix not in field_db_type:
field_db_type = '%s %s' % (field_db_type, self.unsigned_suffix)
return field_db_type
def get_field_db_type_lookup(self, type_code):
return None
def get_field_class(self, class_path):
if '.' in class_path:
module_path, package_name = class_path.rsplit('.', 1)
module = importlib.import_module(module_path)
return getattr(module, package_name)
return getattr(models, class_path)
def get_field_db_nullable(self, field, table_name):
tablespace = field.db_tablespace
if tablespace == "":
tablespace = "public"
attname = field.db_column or field.attname
return self.null.get((tablespace, table_name, attname), 'fixme')
def strip_parameters(self, field_type):
if field_type and field_type != 'double precision':
return field_type.split(" ")[0].split("(")[0].lower()
return field_type
def get_index_together(self, meta):
indexes_normalized = list(normalize_together(meta.index_together))
for idx in meta.indexes:
indexes_normalized.append(idx.fields)
return self.expand_together(indexes_normalized, meta)
def get_unique_together(self, meta):
unique_normalized = list(normalize_together(meta.unique_together))
for constraint in meta.constraints:
if isinstance(constraint, UniqueConstraint):
unique_normalized.append(constraint.fields)
return self.expand_together(unique_normalized, meta)
def expand_together(self, together, meta):
new_together = []
for fields in normalize_together(together):
new_together.append(
tuple(meta.get_field(field).attname for field in fields)
)
return new_together
def find_unique_missing_in_db(self, meta, table_indexes, table_constraints, table_name, skip_list=None):
schema_editor = connection.SchemaEditorClass(connection)
for field in all_local_fields(meta):
if skip_list and field.attname in skip_list:
continue
if field.unique and meta.managed:
attname = field.db_column or field.attname
db_field_unique = table_indexes.get(attname, {}).get('unique')
if not db_field_unique and table_constraints:
db_field_unique = any(constraint['unique'] for contraint_name, constraint in table_constraints.items() if [attname] == constraint['columns'])
if attname in table_indexes and db_field_unique:
continue
index_name = schema_editor._create_index_name(table_name, [attname])
self.add_difference('unique-missing-in-db', table_name, [attname], index_name + "_uniq")
db_type = field.db_type(connection=connection)
if db_type.startswith('varchar'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' varchar_pattern_ops')
if db_type.startswith('text'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' text_pattern_ops')
unique_together = self.get_unique_together(meta)
db_unique_columns = normalize_together([v['columns'] for v in table_constraints.values() if v['unique'] and not v['index']])
for unique_columns in unique_together:
if unique_columns in db_unique_columns:
continue
if skip_list and unique_columns in skip_list:
continue
index_name = schema_editor._create_index_name(table_name, unique_columns)
self.add_difference('unique-missing-in-db', table_name, unique_columns, index_name + "_uniq")
def find_unique_missing_in_model(self, meta, table_indexes, table_constraints, table_name):
fields = dict([(field.column, field) for field in all_local_fields(meta)])
unique_together = self.get_unique_together(meta)
for constraint_name, constraint in table_constraints.items():
if not constraint['unique']:
continue
if constraint['index']:
# unique indexes are handled by find_index_missing_in_model
continue
columns = constraint['columns']
if len(columns) == 1:
field = fields.get(columns[0])
if field is None:
pass
elif field.unique:
continue
else:
if tuple(columns) in unique_together:
continue
self.add_difference('unique-missing-in-model', table_name, constraint_name)
def find_index_missing_in_db(self, meta, table_indexes, table_constraints, table_name):
schema_editor = connection.SchemaEditorClass(connection)
for field in all_local_fields(meta):
if field.db_index:
attname = field.db_column or field.attname
if attname not in table_indexes:
index_name = schema_editor._create_index_name(table_name, [attname])
self.add_difference('index-missing-in-db', table_name, [attname], index_name, '')
db_type = field.db_type(connection=connection)
if db_type.startswith('varchar'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' varchar_pattern_ops')
if db_type.startswith('text'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' text_pattern_ops')
index_together = self.get_index_together(meta)
db_index_together = normalize_together([v['columns'] for v in table_constraints.values() if v['index'] and not v['unique']])
for columns in index_together:
if columns in db_index_together:
continue
index_name = schema_editor._create_index_name(table_name, columns)
self.add_difference('index-missing-in-db', table_name, columns, index_name + "_idx", '')
for index in meta.indexes:
if index.name not in table_constraints:
self.add_difference('index-missing-in-db', table_name, index.fields, index.name, '')
def find_index_missing_in_model(self, meta, table_indexes, table_constraints, table_name):
fields = dict([(field.column, field) for field in all_local_fields(meta)])
meta_index_names = [idx.name for idx in meta.indexes]
index_together = self.get_index_together(meta)
for constraint_name, constraint in table_constraints.items():
if constraint_name in meta_index_names:
continue
if constraint['unique'] and not constraint['index']:
# unique constraints are handled by find_unique_missing_in_model
continue
columns = constraint['columns']
field = fields.get(columns[0])
if (constraint['unique'] and constraint['index']) or field is None:
# unique indexes do not exist in django ? only unique constraints
pass
elif len(columns) == 1:
if constraint['primary_key'] and field.primary_key:
continue
if constraint['foreign_key'] and isinstance(field, models.ForeignKey) and field.db_constraint:
continue
if constraint['unique'] and field.unique:
continue
if constraint['index'] and constraint['type'] == 'idx' and constraint.get('orders') and field.unique:
# django automatically creates a _like varchar_pattern_ops/text_pattern_ops index see https://code.djangoproject.com/ticket/12234
# note: mysql does not have and/or introspect and fill the 'orders' attribute of constraint information
continue
if constraint['index'] and field.db_index:
continue
if constraint['check'] and field.db_check(connection=connection):
continue
if getattr(field, 'spatial_index', False):
continue
else:
if constraint['index'] and tuple(columns) in index_together:
continue
self.add_difference('index-missing-in-model', table_name, constraint_name)
def find_field_missing_in_model(self, fieldmap, table_description, table_name):
for row in table_description:
if row[0] not in fieldmap:
self.add_difference('field-missing-in-model', table_name, row[0])
def find_field_missing_in_db(self, fieldmap, table_description, table_name):
db_fields = [row[0] for row in table_description]
for field_name, field in fieldmap.items():
if field_name not in db_fields:
field_output = []
if field.remote_field:
field_output.extend([field.remote_field.model._meta.db_table, field.remote_field.model._meta.get_field(field.remote_field.field_name).column])
op = 'fkey-missing-in-db'
else:
op = 'field-missing-in-db'
field_output.append(field.db_type(connection=connection))
if self.options['include_defaults'] and field.has_default():
field_output.append('DEFAULT %s' % field.get_prep_value(field.get_default()))
if not field.null:
field_output.append('NOT NULL')
self.add_difference(op, table_name, field_name, *field_output)
self.new_db_fields.add((table_name, field_name))
def find_field_type_differ(self, meta, table_description, table_name, func=None):
db_fields = dict([(row[0], row) for row in table_description])
for field in all_local_fields(meta):
if field.name not in db_fields:
continue
description = db_fields[field.name]
model_type = self.get_field_model_type(field)
db_type = self.get_field_db_type(description, field, table_name)
# use callback function if defined
if func:
model_type, db_type = func(field, description, model_type, db_type)
if not self.strip_parameters(db_type) == self.strip_parameters(model_type):
self.add_difference('field-type-differ', table_name, field.name, model_type, db_type)
def find_field_parameter_differ(self, meta, table_description, table_name, func=None):
db_fields = dict([(row[0], row) for row in table_description])
for field in all_local_fields(meta):
if field.name not in db_fields:
continue
description = db_fields[field.name]
model_type = self.get_field_model_type(field)
db_type = self.get_field_db_type(description, field, table_name)
if not self.strip_parameters(model_type) == self.strip_parameters(db_type):
continue
# use callback function if defined
if func:
model_type, db_type = func(field, description, model_type, db_type)
model_check = field.db_parameters(connection=connection)['check']
if ' CHECK' in db_type:
db_type, db_check = db_type.split(" CHECK", 1)
db_check = db_check.strip().lstrip("(").rstrip(")")
else:
db_check = None
if not model_type == db_type or not model_check == db_check:
self.add_difference('field-parameter-differ', table_name, field.name, model_type, db_type)
def find_field_notnull_differ(self, meta, table_description, table_name):
if not self.can_detect_notnull_differ:
return
for field in all_local_fields(meta):
attname = field.db_column or field.attname
if (table_name, attname) in self.new_db_fields:
continue
null = self.get_field_db_nullable(field, table_name)
if field.null != null:
action = field.null and 'DROP' or 'SET'
self.add_difference('notnull-differ', table_name, attname, action)
def get_constraints(self, cursor, table_name, introspection):
return {}
def find_differences(self):
if self.options['all_applications']:
self.add_app_model_marker(None, None)
for table in self.db_tables:
if table not in self.django_tables and table not in self.IGNORE_MISSING_TABLES:
self.add_difference('table-missing-in-model', table)
cur_app_label = None
for app_model in self.app_models:
meta = app_model._meta
table_name = meta.db_table
app_label = meta.app_label
if not self.options['include_proxy_models'] and meta.proxy:
continue
if cur_app_label != app_label:
# Marker indicating start of difference scan for this table_name
self.add_app_model_marker(app_label, app_model.__name__)
if table_name not in self.db_tables:
# Table is missing from database
self.add_difference('table-missing-in-db', table_name)
continue
if hasattr(self.introspection, 'get_constraints'):
table_constraints = self.introspection.get_constraints(self.cursor, table_name)
else:
table_constraints = self.get_constraints(self.cursor, table_name, self.introspection)
fieldmap = dict([(field.db_column or field.get_attname(), field) for field in all_local_fields(meta)])
# add ordering field if model uses order_with_respect_to
if meta.order_with_respect_to:
fieldmap['_order'] = ORDERING_FIELD
try:
table_description = self.introspection.get_table_description(self.cursor, table_name)
except Exception as e:
self.add_difference('error', 'unable to introspect table: %s' % str(e).strip())
transaction.rollback() # reset transaction
continue
# map table_constraints into table_indexes
table_indexes = {}
for contraint_name, dct in table_constraints.items():
columns = dct['columns']
if len(columns) == 1:
table_indexes[columns[0]] = {
'primary_key': dct['primary_key'],
'unique': dct['unique'],
'type': dct.get('type'),
'contraint_name': contraint_name,
}
# Fields which are defined in database but not in model
# 1) find: 'unique-missing-in-model'
self.find_unique_missing_in_model(meta, table_indexes, table_constraints, table_name)
# 2) find: 'index-missing-in-model'
self.find_index_missing_in_model(meta, table_indexes, table_constraints, table_name)
# 3) find: 'field-missing-in-model'
self.find_field_missing_in_model(fieldmap, table_description, table_name)
# Fields which are defined in models but not in database
# 4) find: 'field-missing-in-db'
self.find_field_missing_in_db(fieldmap, table_description, table_name)
# 5) find: 'unique-missing-in-db'
self.find_unique_missing_in_db(meta, table_indexes, table_constraints, table_name)
# 6) find: 'index-missing-in-db'
self.find_index_missing_in_db(meta, table_indexes, table_constraints, table_name)
# Fields which have a different type or parameters
# 7) find: 'type-differs'
self.find_field_type_differ(meta, table_description, table_name)
# 8) find: 'type-parameter-differs'
self.find_field_parameter_differ(meta, table_description, table_name)
# 9) find: 'field-notnull'
self.find_field_notnull_differ(meta, table_description, table_name)
self.has_differences = max([len(diffs) for _app_label, _model_name, diffs in self.differences])
def print_diff(self, style=no_style()):
""" Print differences to stdout """
if self.options['sql']:
self.print_diff_sql(style)
else:
self.print_diff_text(style)
def print_diff_text(self, style):
if not self.can_detect_notnull_differ:
self.stdout.write(style.NOTICE("# Detecting notnull changes not implemented for this database backend"))
self.stdout.write("")
if not self.can_detect_unsigned_differ:
self.stdout.write(style.NOTICE("# Detecting unsigned changes not implemented for this database backend"))
self.stdout.write("")
cur_app_label = None
for app_label, model_name, diffs in self.differences:
if not diffs:
continue
if not self.dense and app_label and cur_app_label != app_label:
self.stdout.write("%s %s" % (style.NOTICE("+ Application:"), style.SQL_TABLE(app_label)))
cur_app_label = app_label
if not self.dense and model_name:
self.stdout.write("%s %s" % (style.NOTICE("|-+ Differences for model:"), style.SQL_TABLE(model_name)))
for diff in diffs:
diff_type, diff_args = diff
text = self.DIFF_TEXTS[diff_type] % dict(
(str(i), style.SQL_TABLE(', '.join(e) if isinstance(e, (list, tuple)) else e))
for i, e in enumerate(diff_args)
)
text = "'".join(i % 2 == 0 and style.ERROR(e) or e for i, e in enumerate(text.split("'")))
if not self.dense:
self.stdout.write("%s %s" % (style.NOTICE("|--+"), text))
else:
if app_label:
self.stdout.write("%s %s %s %s %s" % (style.NOTICE("App"), style.SQL_TABLE(app_label), style.NOTICE('Model'), style.SQL_TABLE(model_name), text))
else:
self.stdout.write(text)
def print_diff_sql(self, style):
if not self.can_detect_notnull_differ:
self.stdout.write(style.NOTICE("-- Detecting notnull changes not implemented for this database backend"))
self.stdout.write("")
cur_app_label = None
qn = connection.ops.quote_name
if not self.has_differences:
if not self.dense:
self.stdout.write(style.SQL_KEYWORD("-- No differences"))
else:
self.stdout.write(style.SQL_KEYWORD("BEGIN;"))
for app_label, model_name, diffs in self.differences:
if not diffs:
continue
if not self.dense and cur_app_label != app_label:
self.stdout.write(style.NOTICE("-- Application: %s" % style.SQL_TABLE(app_label)))
cur_app_label = app_label
if not self.dense and model_name:
self.stdout.write(style.NOTICE("-- Model: %s" % style.SQL_TABLE(model_name)))
for diff in diffs:
diff_type, diff_args = diff
text = self.DIFF_SQL[diff_type](style, qn, diff_args)
if self.dense:
text = text.replace("\n\t", " ")
self.stdout.write(text)
self.stdout.write(style.SQL_KEYWORD("COMMIT;"))
class GenericSQLDiff(SQLDiff):
can_detect_notnull_differ = False
can_detect_unsigned_differ = False
def load_null(self):
pass
def load_unsigned(self):
pass
class MySQLDiff(SQLDiff):
can_detect_notnull_differ = True
can_detect_unsigned_differ = True
unsigned_suffix = 'UNSIGNED'
def load(self):
super().load()
self.auto_increment = set()
self.load_auto_increment()
def format_field_names(self, field_names):
return [f.lower() for f in field_names]
def load_null(self):
tablespace = 'public'
for table_name in self.db_tables:
result = self.sql_to_dict("""
SELECT column_name, is_nullable
FROM information_schema.columns
WHERE table_schema = DATABASE()
AND table_name = %s""", [table_name])
for table_info in result:
key = (tablespace, table_name, table_info['column_name'])
self.null[key] = table_info['is_nullable'] == 'YES'
def load_unsigned(self):
tablespace = 'public'
for table_name in self.db_tables:
result = self.sql_to_dict("""
SELECT column_name
FROM information_schema.columns
WHERE table_schema = DATABASE()
AND table_name = %s
AND column_type LIKE '%%unsigned'""", [table_name])
for table_info in result:
key = (tablespace, table_name, table_info['column_name'])
self.unsigned.add(key)
def load_auto_increment(self):
for table_name in self.db_tables:
result = self.sql_to_dict("""
SELECT column_name
FROM information_schema.columns
WHERE table_schema = DATABASE()
AND table_name = %s
AND extra = 'auto_increment'""", [table_name])
for table_info in result:
key = (table_name, table_info['column_name'])
self.auto_increment.add(key)
# All the MySQL hacks together create something of a problem
# Fixing one bug in MySQL creates another issue. So just keep in mind
# that this is way unreliable for MySQL atm.
def get_field_db_type(self, description, field=None, table_name=None):
db_type = super().get_field_db_type(description, field, table_name)
if not db_type:
return
if field:
# MySQL isn't really sure about char's and varchar's like sqlite
field_type = self.get_field_model_type(field)
# Fix char/varchar inconsistencies
if self.strip_parameters(field_type) == 'char' and self.strip_parameters(db_type) == 'varchar':
db_type = db_type.lstrip("var")
# They like to call bools various integer types and introspection makes that a integer
# just convert them all to bools
if self.strip_parameters(field_type) == 'bool':
if db_type == 'integer':
db_type = 'bool'
if (table_name, field.column) in self.auto_increment and 'AUTO_INCREMENT' not in db_type:
db_type += ' AUTO_INCREMENT'
return db_type
def find_index_missing_in_model(self, meta, table_indexes, table_constraints, table_name):
fields = dict([(field.column, field) for field in all_local_fields(meta)])
meta_index_names = [idx.name for idx in meta.indexes]
index_together = self.get_index_together(meta)
unique_together = self.get_unique_together(meta)
for constraint_name, constraint in table_constraints.items():
if constraint_name in meta_index_names:
continue
if constraint['unique'] and not constraint['index']:
# unique constraints are handled by find_unique_missing_in_model
continue
columns = constraint['columns']
field = fields.get(columns[0])
# extra check removed from superclass here, otherwise function is the same
if len(columns) == 1:
if not field:
# both index and field are missing from the model
self.add_difference('index-missing-in-model', table_name, constraint_name)
continue
if constraint['primary_key'] and field.primary_key:
continue
if constraint['foreign_key'] and isinstance(field, models.ForeignKey) and field.db_constraint:
continue
if constraint['unique'] and field.unique:
continue
if constraint['index'] and constraint['type'] == 'idx' and constraint.get('orders') and field.unique:
# django automatically creates a _like varchar_pattern_ops/text_pattern_ops index see https://code.djangoproject.com/ticket/12234
# note: mysql does not have and/or introspect and fill the 'orders' attribute of constraint information
continue
if constraint['index'] and field.db_index:
continue
if constraint['check'] and field.db_check(connection=connection):
continue
if getattr(field, 'spatial_index', False):
continue
else:
if constraint['index'] and tuple(columns) in index_together:
continue
if constraint['index'] and constraint['unique'] and tuple(columns) in unique_together:
continue
self.add_difference('index-missing-in-model', table_name, constraint_name)
def find_unique_missing_in_db(self, meta, table_indexes, table_constraints, table_name, skip_list=None):
schema_editor = connection.SchemaEditorClass(connection)
for field in all_local_fields(meta):
if skip_list and field.attname in skip_list:
continue
if field.unique and meta.managed:
attname = field.db_column or field.attname
db_field_unique = table_indexes.get(attname, {}).get('unique')
if not db_field_unique and table_constraints:
db_field_unique = any(constraint['unique'] for contraint_name, constraint in table_constraints.items() if [attname] == constraint['columns'])
if attname in table_indexes and db_field_unique:
continue
index_name = schema_editor._create_index_name(table_name, [attname])
self.add_difference('unique-missing-in-db', table_name, [attname], index_name + "_uniq")
db_type = field.db_type(connection=connection)
if db_type.startswith('varchar'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' varchar_pattern_ops')
if db_type.startswith('text'):
self.add_difference('index-missing-in-db', table_name, [attname], index_name + '_like', ' text_pattern_ops')
unique_together = self.get_unique_together(meta)
# This comparison changed from superclass - otherwise function is the same
db_unique_columns = normalize_together([v['columns'] for v in table_constraints.values() if v['unique']])
for unique_columns in unique_together:
if unique_columns in db_unique_columns:
continue
if skip_list and unique_columns in skip_list:
continue
index_name = schema_editor._create_index_name(table_name, unique_columns)
self.add_difference('unique-missing-in-db', table_name, unique_columns, index_name + "_uniq")
class SqliteSQLDiff(SQLDiff):
can_detect_notnull_differ = True
can_detect_unsigned_differ = False
def load_null(self):
for table_name in self.db_tables:
# sqlite does not support tablespaces
tablespace = "public"
# index, column_name, column_type, nullable, default_value
# see: https://www.sqlite.org/pragma.html#pragma_table_info
for table_info in self.sql_to_dict("PRAGMA table_info('%s');" % table_name, []):
key = (tablespace, table_name, table_info['name'])
self.null[key] = not table_info['notnull']
def load_unsigned(self):
pass
# Unique does not seem to be implied on Sqlite for Primary_key's
# if this is more generic among databases this might be usefull
# to add to the superclass's find_unique_missing_in_db method
def find_unique_missing_in_db(self, meta, table_indexes, table_constraints, table_name, skip_list=None):
if skip_list is None:
skip_list = []
unique_columns = [field.db_column or field.attname for field in all_local_fields(meta) if field.unique]
for constraint in table_constraints.values():
columns = constraint['columns']
if len(columns) == 1:
column = columns[0]
if column in unique_columns and (constraint['unique'] or constraint['primary_key']):
skip_list.append(column)
unique_together = self.get_unique_together(meta)
db_unique_columns = normalize_together([v['columns'] for v in table_constraints.values() if v['unique']])
for unique_columns in unique_together:
if unique_columns in db_unique_columns:
skip_list.append(unique_columns)
super().find_unique_missing_in_db(meta, table_indexes, table_constraints, table_name, skip_list=skip_list)
# Finding Indexes by using the get_indexes dictionary doesn't seem to work
# for sqlite.
def find_index_missing_in_db(self, meta, table_indexes, table_constraints, table_name):
pass
def find_index_missing_in_model(self, meta, table_indexes, table_constraints, table_name):
pass
def get_field_db_type(self, description, field=None, table_name=None):
db_type = super().get_field_db_type(description, field, table_name)
if not db_type:
return None
if field:
field_type = self.get_field_model_type(field)
# Fix char/varchar inconsistencies
if self.strip_parameters(field_type) == 'char' and self.strip_parameters(db_type) == 'varchar':
db_type = db_type.lstrip("var")
return db_type