forked from bugzilla/bugzilla-schema
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema_remarks.py
5631 lines (3749 loc) · 161 KB
/
schema_remarks.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
# Perforce Defect Tracking Integration Project
# <http://www.ravenbrook.com/project/p4dti/>
#
# SCHEMA-REMARKS.PY -- REMARKS FOR BUGZILLA SCHEMA DOCUMENTATION
#
# Nick Barnes, Ravenbrook Limited, 2003-07-07
#
#
# 1. INTRODUCTION
#
# This module contains data structures holding remarks concerning
# the Bugzilla schema. These remarks are automatically included in the
# Bugzilla schema doc by the code in make_schema_doc.py.
#
# The intended readership is project developers.
#
# This document is not confidential.
import string
import re
# All the strings here are going to be passed to Python's % formatting
# operator, with a dictionary on the right-hand-side containing various
# strings which can therefore be automatically inserted.
#
# %(column-foo-bar)s turns into a link "foo.bar" to column bar of table foo.
#
# %(table-foo)s turns into a link "foo" to table foo.
#
# %(the-table-foo)s turns into "the foo table" where "foo" is a link
# to table foo.
#
# and some other special-case strings such as VERSION_STRING,
# VERSION_COLOUR, and so on.
# Bugzilla versions which we know about, in order.
version_order = [
'2.0',
'2.2',
'2.4',
'2.6',
'2.8',
'2.10',
'2.12',
'2.14',
'2.14.1',
'2.14.2',
'2.14.3',
'2.14.4',
'2.14.5',
'2.16rc1',
'2.16rc2',
'2.16',
'2.16.1',
'2.16.2',
'2.16.3',
'2.16.4',
'2.16.5',
'2.16.6',
'2.16.7',
'2.16.8',
'2.16.9',
'2.16.10',
'2.16.11',
'2.17.1',
'2.17.2',
'2.17.3',
'2.17.4',
'2.17.5',
'2.17.6',
'2.17.7',
'2.18rc1',
'2.18rc2',
'2.18rc3',
'2.18',
'2.18.1',
'2.18.2',
'2.18.3',
'2.18.4',
'2.18.5',
'2.18.6',
'2.19.1',
'2.19.2',
'2.19.3',
'2.20rc1',
'2.20rc2',
'2.20',
'2.20.1',
'2.20.2',
'2.20.3',
'2.20.4',
'2.20.5',
'2.20.6',
'2.20.7',
'2.21.1',
'2.22rc1',
'2.22',
'2.22.1',
'2.22.2',
'2.22.3',
'2.22.4',
'2.22.5',
'2.22.6',
'2.22.7',
'2.23.1',
'2.23.2',
'2.23.3',
'2.23.4',
'3.0rc1',
'3.0',
'3.0.1',
'3.0.2',
'3.0.3',
'3.0.4',
'3.0.5',
'3.0.6',
'3.0.7',
'3.0.8',
'3.0.9',
'3.1.1',
'3.1.2',
'3.1.3',
'3.1.4',
'3.2rc1',
'3.2rc2',
'3.2',
'3.2.1',
'3.2.2',
'3.2.3',
'3.2.4',
'3.2.5',
'3.3.1',
'3.3.2',
'3.3.3',
'3.3.4',
'3.4rc1',
'3.4',
'3.4.1',
'3.4.2',
]
default_first_version = '3.0'
default_last_version = '3.4.2'
# Bugzilla schema versions. A map from Bugzilla version to
# the version which introduces the schema used in that version.
version_schema_map = {
'2.0': '2.0',
'2.2': '2.2',
'2.4': '2.4',
'2.6': '2.6',
'2.8': '2.8',
'2.10': '2.10',
'2.12': '2.12',
'2.14': '2.14',
'2.14.1': '2.14',
'2.14.2': '2.14.2',
'2.14.3': '2.14.2',
'2.14.4': '2.14.2',
'2.14.5': '2.14.2',
'2.16rc1': '2.16',
'2.16rc2': '2.16',
'2.16': '2.16',
'2.16.1': '2.16',
'2.16.2': '2.16',
'2.16.3': '2.16',
'2.16.4': '2.16',
'2.16.5': '2.16',
'2.16.6': '2.16',
'2.16.7': '2.16',
'2.16.8': '2.16',
'2.16.9': '2.16',
'2.16.10': '2.16',
'2.16.11': '2.16',
'2.17.1': '2.17.1',
'2.17.2': '2.17.1',
'2.17.3': '2.17.3',
'2.17.4': '2.17.4',
'2.17.5': '2.17.5',
'2.17.6': '2.17.5',
'2.17.7': '2.17.7',
'2.18rc1': '2.18rc1',
'2.18rc2': '2.18rc1',
'2.18rc3': '2.18rc3',
'2.18': '2.18rc3',
'2.18.1': '2.18.1',
'2.18.2': '2.18.2',
'2.18.3': '2.18.2',
'2.18.4': '2.18.2',
'2.18.5': '2.18.2',
'2.18.6': '2.18.2',
'2.19.1': '2.19.1',
'2.19.2': '2.19.2',
'2.19.3': '2.19.3',
'2.20rc1': '2.20rc1',
'2.20rc2': '2.20rc2',
'2.20': '2.20rc2',
'2.20.1': '2.20rc2',
'2.20.2': '2.20rc2',
'2.20.3': '2.20rc2',
'2.20.4': '2.20rc2',
'2.20.5': '2.20rc2',
'2.20.6': '2.20rc2',
'2.20.7': '2.20rc2',
'2.21.1': '2.21.1',
'2.22rc1': '2.22rc1',
'2.22': '2.22rc1',
'2.22.1': '2.22rc1',
'2.22.2': '2.22rc1',
'2.22.3': '2.22rc1',
'2.22.4': '2.22rc1',
'2.22.5': '2.22rc1',
'2.22.6': '2.22rc1',
'2.22.7': '2.22rc1',
'2.23.1': '2.23.1',
'2.23.2': '2.23.2',
'2.23.3': '2.23.3',
'2.23.4': '2.23.4',
'3.0rc1': '2.23.4',
'3.0': '2.23.4',
'3.0.1': '2.23.4',
'3.0.2': '2.23.4',
'3.0.3': '2.23.4',
'3.0.4': '2.23.4',
'3.0.5': '2.23.4',
'3.0.6': '2.23.4',
'3.0.7': '2.23.4',
'3.0.8': '2.23.4',
'3.0.9': '2.23.4',
'3.1.1': '3.1.1',
'3.1.2': '3.1.2',
'3.1.3': '3.1.3',
'3.1.4': '3.1.4',
'3.2rc1': '3.1.4',
'3.2rc2': '3.1.4',
'3.2': '3.1.4',
'3.2.1': '3.1.4',
'3.2.2': '3.1.4',
'3.2.3': '3.1.4',
'3.2.4': '3.1.4',
'3.2.5': '3.1.4',
'3.3.1': '3.3.1',
'3.3.2': '3.3.2',
'3.3.3': '3.3.2',
'3.3.4': '3.3.4',
'3.4rc1': '3.3.4',
'3.4': '3.3.4',
'3.4.1': '3.3.4',
'3.4.2': '3.3.4',
}
version_remark = [
('2.0', '1998-09-19', ''),
('2.2', '1999-02-10', ''),
('2.4', '1999-04-30', ''),
('2.6', '1999-08-30', ''),
('2.8', '1999-11-19', ''),
('2.10', '2000-05-09', ''),
('2.12', '2001-04-27', ''),
('2.14', '2001-08-29', ''),
('2.14.1', '2002-01-05', 'A security patch release.'),
('2.16rc1', '2002-05-10', 'A release candidate.'),
('2.16rc2', '2002-06-07', 'A release candidate.'),
('2.14.2', '2002-06-07', 'A security patch release.'),
('2.16', '2002-07-28', ''),
('2.14.3', '2002-07-28', 'A security patch release.'),
('2.16.1', '2002-09-30', 'A security patch release.'),
('2.14.4', '2002-09-30', 'A security patch release.'),
('2.17.1', '2002-11-25', 'A development release.'),
('2.16.2', '2003-01-02', 'A security patch release.'),
('2.14.5', '2003-01-02', 'A security patch release.'),
('2.17.3', '2003-01-02', 'A development release.'),
('2.16.3', '2003-04-25', 'A security patch release.'),
('2.17.4', '2003-04-25', 'A development release.'),
('2.17.5', '2003-11-03', 'A development release.'),
('2.16.4', '2003-11-03', 'A security patch release'),
('2.17.6', '2003-11-10', 'A development release.'),
('2.16.5', '2004-03-03', 'A security patch release'),
('2.17.7', '2004-03-03', 'A development release.'),
('2.16.6', '2004-07-10', 'A security patch release'),
('2.18rc1', '2004-07-10', 'A release candidate.'),
('2.18rc2', '2004-07-28', 'A release candidate.'),
('2.16.7', '2004-10-24', 'A security patch release'),
('2.18rc3', '2004-10-24', 'A release candidate.'),
('2.19.1', '2004-10-24', 'A development release.'),
('2.16.8', '2005-01-15', 'A security patch release'),
('2.18', '2005-01-15', ''),
('2.19.2', '2005-01-15', 'A development release.'),
('2.16.9', '2005-05-12', 'A security patch release'),
('2.18.1', '2005-05-12', 'A security patch release'),
('2.19.3', '2005-05-12', 'A development release.'),
('2.16.10', '2005-05-19', 'A security patch release'),
('2.18.2', '2005-07-08', 'A security patch release'),
('2.20rc1', '2005-07-08', 'A release candidate'),
('2.18.3', '2005-07-09', 'A security patch release'),
('2.20rc2', '2005-08-08', 'A release candidate'),
('2.18.4', '2005-10-01', 'A security patch release'),
('2.20', '2005-10-01', ''),
('2.21.1', '2005-10-01', 'A development release.'),
('2.16.11', '2006-02-21', 'A security patch release'),
('2.18.5', '2006-02-21', 'A security patch release'),
('2.20.1', '2006-02-21', 'A security patch release'),
('2.22rc1', '2006-02-21', 'A release candidate'),
('2.20.2', '2006-04-23', 'A security patch release'),
('2.22', '2006-04-23', ''),
('2.23.1', '2006-04-23', 'A development release.'),
('2.23.2', '2006-07-09', 'A development release.'),
('2.18.6', '2006-10-15', 'A security patch release'),
('2.20.3', '2006-10-15', 'A security patch release'),
('2.22.1', '2006-10-15', 'A security patch release'),
('2.23.3', '2006-10-15', 'A development release'),
('2.20.4', '2007-02-02', 'A security patch release'),
('2.22.2', '2007-02-02', 'A security patch release'),
('2.23.4', '2007-02-02', 'A development release'),
('3.0rc1', '2007-02-26', 'A release candidate'),
('3.0', '2007-05-09', ''),
('2.20.5', '2007-08-23', 'A security patch release'),
('2.22.3', '2007-08-23', 'A security patch release'),
('3.0.1', '2007-08-23', 'A security patch release'),
('3.1.1', '2007-08-23', 'A development release'),
('3.0.2', '2007-09-19', 'A security patch release'),
('3.1.2', '2007-09-19', 'A development release'),
('3.0.3', '2008-01-09', 'A patch release'),
('3.1.3', '2008-02-02', 'A development release'),
('2.20.6', '2008-05-04', 'A security patch release'),
('2.22.4', '2008-05-04', 'A security patch release'),
('3.0.4', '2008-05-04', 'A security patch release'),
('3.1.4', '2008-05-04', 'A development release'),
('2.22.5', '2008-08-12', 'A security patch release'),
('3.0.5', '2008-08-12', 'A security patch release'),
('3.2rc1', '2008-08-12', 'A release candidate'),
('2.20.7', '2008-11-07', 'A security patch release'),
('2.22.6', '2008-11-07', 'A security patch release'),
('3.0.6', '2008-11-07', 'A security patch release'),
('3.2rc2', '2008-11-07', 'A release candidate'),
('3.2', '2008-11-30', ''),
('3.3.1', '2009-01-06', 'A development release'),
('2.22.7', '2009-02-03', 'A security patch release'),
('3.0.7', '2009-02-03', 'A security patch release'),
('3.2.1', '2009-02-03', 'A security patch release'),
('3.0.8', '2009-02-03', 'A security patch release'),
('3.2.2', '2009-02-03', 'A security patch release'),
('3.3.2', '2009-02-03', 'A development release'),
('3.3.3', '2009-02-03', 'A security patch reease'),
('3.2.3', '2009-03-31', 'A security patch release'),
('3.3.4', '2009-03-31', 'A development release'),
('3.2.4', '2009-07-08', 'A security patch release'),
('3.4rc1', '2009-07-08', 'A development release'),
('3.4', '2009-07-28', ''),
('3.4.1', '2009-08-01', 'A security patch release'),
('3.0.9', '2009-09-11', 'A security patch release'),
('3.2.5', '2009-09-11', 'A security patch release'),
('3.4.2', '2009-09-11', 'A security patch release'),
]
# This is a map from table name to an HTML remark concerning that
# table, which is output before the schema for that table.
#
# Tables with no attached remarks are given 'None' as a placeholder, so
# we know to add a remark later.
table_remark = {
'attachments': 'Bug <a href="#notes-attachments">attachments</a>.',
'attach_data': 'The content of <a href="#notes-attachments">attachments</a>.',
'attachstatusdefs': 'Attachment status definitions.',
'attachstatuses': 'Attachment statuses.',
'bug_group_map': 'Which bugs are in which groups. See <a href="#notes-groups">the notes on groups</a>.',
'bug_see_also': '<a href="#notes-see_also">Related bugs</a> in other Bugzillas.',
'bug_severity': 'The severity values of bugs.',
'bug_status': 'The status values of bugs.',
'bugs': 'The bugs themselves.',
'bugs_activity': '<a href="#notes-activity">Activity</a> on the bugs table.',
'bugs_fulltext': 'All the descriptive text on bugs, to speed up searching.',
'bz_schema': 'The database schema itself.',
'category_group_map': 'Which groups does a user have to be in to view chart data in a given category. See <a href="#notes-charts">the notes on charts</a>. ',
'cc': 'Users who have asked to receive <a href="#notes-email">email</a> when a bug changes.',
'component_cc': 'Users to put on the <a href="#notes-email">CC list</a> for a new bug in a given component.',
'classifications': 'Product classifications. See <a href="#notes-products">the notes on products</a>.',
'components': 'One row for each component. See <a href="#notes-products">the notes on products and components.</a>',
'dependencies': 'Which bugs <a href="#notes-dependencies">depend</a> on other bugs.',
'duplicates': 'Which bugs are duplicates of which other bugs.',
'email_setting': 'Per-user settings controlling when email is sent to that user.',
'fielddefs': 'The properties of each bug field.',
'flagexclusions': 'It may be forbidden to set a given flag on an item (bug or attachment) if that item is in a given product and/or component. This table records such exclusions. See the notes on <a href="#notes-flags">flags</a>.',
'flaginclusions': 'An item (bug or attachment) may be required to be in a given product and/or component for a flag to be set. This table records such requirements. See the notes on <a href="#notes-flags">flags</a>.',
'flags': 'This table records the flags set on bugs or attachments. See the notes on <a href="#notes-flags">flags</a>.',
'flagtypes': 'The types of flags available for bugs and attachments. See the notes on <a href="#notes-flags">flags</a>.',
'group_control_map': 'This table describes the relationship of groups to products (whether membership in a given group is required for entering or editing a bug in a given product). See <a href="#notes-groups">the notes on groups</a>.',
'group_group_map': 'Groups can be configured such that membership of one group automatically confers rights over some other groups. This table records that configuration. See <a href="#notes-groups">the notes on groups</a>.',
'groups': 'This table describes a number of user groups. Each group allows its members to perform a restricted activity. See <a href="#notes-groups">the notes on groups</a>. ',
'keyworddefs': 'Names and definitions of the keywords. See <a href="#notes-keywords">the notes on keywords</a>.',
'keywords': 'Bugs may have keywords. This table defines which bugs have which keywords. The keywords are defined in %(the-table-keyworddefs)s.',
'logincookies': 'Bugzilla generates a cookie each time a user logs in, and uses it for subsequent authentication. The cookies generated are stored in this table. For more information, see <a href="#notes-authentication">the notes on authentication</a>.',
'longdescs': 'Long bug <a href="#notes-descriptions">descriptions</a>.',
'milestones': 'Development <a href="#notes-milestones">milestones</a>.',
'namedqueries': 'Named <a href="#notes-namedqueries">queries</a>.',
'namedquery_group_map': 'Controls whether a <a href="#notes-namedqueries">named query</a> is shared with other users (other members of a group).',
'namedqueries_link_in_footer': 'Controls whether a <a href="#notes-namedqueries">named query</a> appears in a given user\'s navigation footer.',
'op_sys': 'The possible values of the "operating system" field of a bug.',
'priority': 'The possible values of the "priority" field of a bug.',
'products': 'One row for each product. See <a href="#notes-products">the notes on products.</a>',
'profile_setting': 'User preference settings.',
'profiles': 'Describes Bugzilla <a href="#notes-users">users</a>. One row per user.',
'profiles_activity': 'This table is for recording changes to %(the-table-profiles)s. Currently it only records changes to group membership made with editusers.cgi. This allows the administrator to track group inflation. There is currently no code to inspect this table; only to add to it.',
'quips': 'A table of <a href="#notes-quips">quips</a>.',
'rep_platform': 'The possible values of the "platform" field of a bug.',
'resolution': 'The possible values of the "resolution" field of a bug.',
'series': 'Properties of the time-series datasets available (e.g. for plotting charts). See <a href="#notes-charts">the notes on charts</a>.',
'series_categories': None,
'series_data': 'Data for plotting time-series charts. See <a href="#notes-charts">the notes on charts</a>.',
'setting': 'Identifies the set of user preferences.',
'setting_value': 'Possible values for user preferences.',
'shadowlog': 'A log of SQL activity; used for updating <a href="#notes-shadow">shadow databases</a>.',
'status_workflow': 'Identifies allowable <a href="#notes-workflow">workflow</a> transitions.',
'tokens': 'Tokens are sent to users to track activities such as creating new accounts and changing email addresses or passwords. They are also sent to browsers and used to track workflow, to prevent security problems (e.g. so that one can only delete groups from a session last seen on a group management page).',
'ts_error': 'A log of errors from TheSchwartz asynchronous job-queueing system. Rows are aged out of this table after seven days.',
'ts_exitstatus': 'A log of job completions from TheSchwartz asynchronous job-queueing system.',
'ts_funcmap': 'The table of functions for TheSchwartz asynchronous job-queueing system.',
'ts_job': 'The job queue managed by TheSchwartz asynchronous job-queueing system.',
'ts_note': 'Notes on jobs for TheSchwartz asynchronous job-queueing system. Apparently not used.',
'user_group_map': 'This table records which users are members of each group, or can "bless" each group. See <a href="#notes-groups">the notes on groups</a>.',
'user_series_map': 'User subscriptions to time-series datasets. See <a href="#notes-charts">the notes on charts</a>.',
'versions': 'Product <a href="#notes-versions">versions</a>.',
'votes': '<a href="#notes-voting">votes</a>.',
'watch': '<a href="#notes-watchers">watchers</a>.',
'whine_events': 'One row for each regular whine event. See <a href="#notes-whine">the notes on whining</a>.',
'whine_queries': 'See <a href="#notes-whine">the notes on whining</a>.',
'whine_schedules': 'See <a href="#notes-whine">the notes on whining</a>.',
}
table_added_remark = {
'attachments': None,
'attach_data': 'Speeding up attachment queries',
'attachstatusdefs': None,
'attachstatuses': None,
'bug_group_map': 'Part of the new groups system',
'bug_see_also': None,
'bug_severity': 'Removing enumerated types',
'bug_status': 'Removing enumerated types',
'bugs_fulltext': 'Improving full-text search speed',
'bz_schema': None,
'category_group_map': 'Part of the new charting system',
'component_cc': None,
'classifications': None,
'dependencies': None,
'duplicates': None,
'email_setting': 'Replaces %(column-profiles-emailflags)s',
'fielddefs': None,
'flagexclusions': 'Part of the new flags system',
'flaginclusions': 'Part of the new flags system',
'flags': 'Part of the new flags system',
'flagtypes': 'Part of the new flags system',
'group_control_map': 'Part of the new groups system',
'group_group_map': 'Part of the new groups system',
'groups': None,
'keywords': None,
'keyworddefs': None,
'longdescs': None,
'milestones': None,
'namedqueries': None,
'namedqueries_link_in_footer': 'Replacing %(column-namedqueries-linkinfooter)s',
'namedquery_group_map': None,
'op_sys': 'Removing enumerated types',
'priority': 'Removing enumerated types',
'products': None,
'profile_setting': None,
'profiles_activity': None,
'quips': None,
'rep_platform': 'Removing enumerated types',
'resolution': 'Removing enumerated types',
'series': 'Part of the new charting system',
'series_categories': 'Part of the new charting system',
'series_data': 'Part of the new charting system',
'setting': None,
'setting_value': None,
'shadowlog': None,
'status_workflow': 'Part of the custom workflow system',
'tokens': None,
'ts_error': 'For asynchronous mail',
'ts_exitstatus': 'For asynchronous mail',
'ts_funcmap': 'For asynchronous mail',
'ts_job': 'For asynchronous mail',
'ts_note': 'For asynchronous mail',
'user_group_map': 'Part of the new groups system',
'user_series_map': 'Part of the new charting system',
'votes': None,
'watch': None,
'whine_events': 'Part of the new whine system',
'whine_queries': 'Part of the new whine system',
'whine_schedules': 'Part of the new whine system',
}
table_removed_remark = {
'attachstatusdefs': 'replaced by the flag tables',
'attachstatuses': ' replaced by the flag tables',
'shadowlog': 'similar functionality now available using MySQL\'s replication facilities',
'user_series_map': 'partially replaced by %(the-table-category_group_map)s',
}
# This is a map from table name to a map from column name to HTML
# remark for that column. At present, these remarks include schema
# change comments (which will eventually be generated automatically).
#
# Columns with no attached remarks are given 'None' as a placeholder,
# so we know to add a remark later.
column_remark = {
'attachments': {
'attach_id': 'a unique ID.',
'bug_id': 'the bug to which this is attached (foreign key %(column-bugs-bug_id)s)',
'creation_ts': 'the creation time.',
'description': 'a description of the attachment.',
'mimetype': 'the MIME type of the attachment.',
'modification_time': 'the modification time of the attachment.',
'ispatch': 'non-zero if this attachment is a patch file.',
'isprivate': 'Non-zero if this attachment is "private", i.e. only visible to members of the "insider" group.',
'isobsolete': 'Non-zero if this attachment is marked as obsolete.',
'isurl': 'Non-zero if this attachment is actually a URL.',
'filename': 'the filename of the attachment.',
'thedata': 'the content of the attachment.',
'submitter_id': 'the userid of the attachment (foreign key %(column-profiles-userid)s)',
},
'attach_data': {
'id': 'The attachment id (foreign key %(column-attachments-attach_id)s).',
'thedata': 'the content of the attachment.',
},
'attachstatusdefs': {
'id': 'a unique ID.',
'name': 'the name of the attachment status.',
'description': 'The description of the attachment status.',
'sortkey': 'A number used to determine the order in which attachment statuses are shown.',
'product': 'The product for which bugs can have attachments with this status (foreign key %(column-products-product)s)',
},
'attachstatuses': {
'attach_id': 'The id of the attachment (foreign key %(column-attachments-attach_id)s)',
'statusid': 'The id of the status (foreign key %(column-attachstatusdefs-id)s)',
},
'bug_group_map': {
'bug_id': 'The bug id, (foreign key %(column-bugs-bug_id)s)',
'group_id': 'The group id, (foreign key %(column-groups-id)s)',
},
'bug_see_also': {
'bug_id': 'The bug id, (foreign key %(column-bugs-bug_id)s)',
'value': 'The URL of a related bug in another Bugzilla.',
},
'bug_severity': {
'value': 'A possible value of the field',
'isactive': '1 if this value is available in the user interface, 0 otherwise',
'sortkey': 'A number used to determine the order in which values are shown.',
'id': 'a unique ID.',
'visibility_value_id': 'If set, this value is only available if the chooser field (identified by %(column-fielddefs-value_field_id)s) has the value with this ID. Foreign key <field>.id, for example %(column-products-id)s or <a href="#column-customfield-id">cf_<field>.id</a>.',
},
'bug_status': {
'value': 'A possible value of the field',
'isactive': '1 if this value is available in the user interface, 0 otherwise',
'sortkey': 'A number used to determine the order in which values are shown.',
'is_open': '1 if the status is "Open", 0 if it is "Closed".',
'id': 'a unique ID.',
'visibility_value_id': 'If set, this value is only available if the chooser field (identified by %(column-fielddefs-value_field_id)s) has the value with this ID. Foreign key <field>.id, for example %(column-products-id)s or <a href="#column-customfield-id">cf_<field>.id</a>.',
},
'bugs': {
'area': 'The development area of the bug.',
'bug_id': 'The bug ID.',
'groupset': 'The groups which this bug occupies. Each group corresponds to one bit. See %(the-table-groups)s.',
'assigned_to': 'The current owner of the bug (foreign key %(column-profiles-userid)s).',
'bug_file_loc': 'A URL which points to more information about the bug.',
'bug_severity': ['See the <a href="#notes-severity">notes</a>.',
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-bug_severity-value)s.'),
],
'bug_status': ['The <a href="#notes-workflow">workflow</a> status of the bug.',
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-bug_status-value)s.'),
],
'creation_ts': 'The times of the bug\'s creation.',
'delta_ts': 'The timestamp of the last update. This includes updates to some related tables (e.g. %(the-table-longdescs)s).',
'long_desc': 'A long description of the bug.',
'short_desc': 'A short description of the bug.',
'op_sys': ['The operating system on which the bug was observed.',
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-op_sys-value)s.'),
],
'priority': ['The priority of the bug.',
(None, '2.19.2', '%(VERSION_STRING)s: P1 = most urgent, P5 = least urgent).'),
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-priority-value)s.'),
],
'product': 'The product (foreign key %(column-products-product)s)',
'product_id': 'The product (foreign key %(column-products-id)s)',
'rep_platform': ['The platform on which the bug was reported.',
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-rep_platform-value)s.'),
],
'reporter': 'The user who reported this (foreign key %(column-profiles-userid)s)',
'version': 'The product version (foreign key %(column-versions-value)s)',
'component': 'The product component (foreign key %(column-components-value)s)',
'component_id': 'The product component (foreign key %(column-components-id)s)',
'resolution': ['The bug\'s <a href="#notes-workflow">resolution</a>',
('2.19.3', None, '%(VERSION_STRING)sforeign key %(column-resolution-value)s.'),
],
'target_milestone': 'The milestone by which this bug should be resolved. (foreign key %(column-milestones-value)s)',
'qa_contact': 'The QA contact (foreign key %(column-profiles-userid)s)',
'status_whiteboard': 'This seems to be just a small whiteboard field.',
'votes': 'The number of votes.',
'keywords': 'A set of keywords. Note that this duplicates the information in %(the-table-keywords)s. (foreign key %(column-keyworddefs-name)s)',
'lastdiffed': 'The time at which information about this bug changing was last emailed to the cc list.',
'everconfirmed': '1 if this bug has ever been confirmed. This is used for validation of some sort.',
'reporter_accessible': '1 if the reporter can see this bug (even if in the wrong group); 0 otherwise.',
'assignee_accessible': '1 if the assignee can see this bug (even if in the wrong group); 0 otherwise.',
'qacontact_accessible': '1 if the QA contact can see this bug (even if in the wrong group); 0 otherwise.',
'cclist_accessible': '1 if people on the CC list can see this bug (even if in the wrong group); 0 otherwise.',
'estimated_time': 'The original estimate of the total effort required to fix this bug (in hours).',
'remaining_time': 'The current estimate of the remaining effort required to fix this bug (in hours).',
'alias': 'An alias for the bug which can be used instead of the bug number.',
'deadline': 'The deadline for this bug (a date).',
},
'bugs_activity': {
'bug_id': 'Which bug (foreign key %(column-bugs-bug_id)s)',
'who': 'Which user (foreign key %(column-profiles-userid)s)',
'when': 'When was the change made?',
'bug_when': 'When was the change made?',
'field': 'What was the field?',
'fieldid': 'What was the fieldid? (foreign key %(column-fielddefs-id)s)',
'attach_id': 'If the change was to an attachment, the ID of the attachment (foreign key %(column-attachments-attach_id)s)',
'oldvalue': 'The head of the old value.',
'newvalue': 'The head of the new value.',
'added': 'The new value of this field, or values which have been added for multi-value fields such as %(column-bugs-keywords)s, %(the-table-cc)s, and %(the-table-dependencies)s',
'removed': 'The old value of this field, or values which have been removed for multi-value fields such as %(column-bugs-keywords)s, %(the-table-cc)s, and %(the-table-dependencies)s',
},
'bugs_fulltext': {
'bug_id': 'Which bug (foreign key %(column-bugs-bug_id)s)',
'short_desc': 'The bug\'s short description (%(column-bugs-short_desc)s)',
'comments': 'The bug\'s comments, concatenated (%(column-longdescs-thetext)s)',
'comments_noprivate': 'Those comments visible to non-members of the "insider" group (i.e. with %(column-longdescs-isprivate)s zero).',
},
'bz_schema': {
'version': 'The version number of the abstract schema data structures. This is <em>not</em> the schema version; it does not change as tables, columns, and indexes are added and removed.',
'schema_data': 'A Perl Storable (serialized version) of the abstract schema.',
},
'category_group_map': {
'category_id': 'The series category (foreign key %(column-series_categories-id)s)',
'group_id': 'The group. (foreign key %(column-groups-id)s)',
},
'cc': {
'bug_id': 'The bug (foreign key %(column-bugs-bug_id)s)',
'who': 'The user (foreign key %(column-profiles-userid)s)',
},
'classifications': {
'id': 'The classification id.',
'name': 'The classification name.',
'description': 'A description of the classification',
'sortkey': 'A number used to determine the order in which classifications are shown.',
},
'components': {
'name': 'The component id.',
'id': 'The component id.',
'value': 'The component name.',
'program': 'The product (foreign key %(column-products-product)s)',
'product_id': 'The product (foreign key %(column-products-id)s)',
'initialowner': ['The default initial owner of bugs in this component. On component creation, this is set to the user who creates the component.',
(None, '2.10', '%(VERSION_STRING)sforeign key %(column-profiles-login_name)s.'),
('2.12', None , '%(VERSION_STRING)sforeign key %(column-profiles-userid)s.'),
],
'initialqacontact': ['The initial "qa_contact" field for bugs of this component. Note that the use of the qa_contact field is optional, parameterized by Param("useqacontact").',
(None, '2.10', '%(VERSION_STRING)sforeign key %(column-profiles-login_name)s.'),
('2.12', None, '%(VERSION_STRING)sforeign key %(column-profiles-userid)s.'),
],
'description': 'A description of the component.',
},
'component_cc': {
'component_id': 'The component id (foreign key %(column-components-id)s).',
'user_id': 'The user id (foreign key %(column-profiles-userid)s).',
},
'dependencies': {
'blocked': 'Which bug is blocked (foreign key %(column-bugs-bug_id)s)',
'dependson': 'Which bug does it depend on (foreign key %(column-bugs-bug_id)s)',
},
'duplicates': {
'dupe_of': 'The bug which is duplicated (foreign key %(column-bugs-bug_id)s)',
'dupe': 'The duplicate bug (foreign key %(column-bugs-bug_id)s)',
},
'email_setting': {
'user_id': 'The user to whom this setting applies (foreign key %(column-profiles-userid)s).',
'relationship': 'The relationship between the user and the bug. 0: Assignee; 1: QA contact; 2: Reporter; 3: CC; 4: Voter; 100: for global events, which do not depend on a relationship.',
'event': 'The event on which an email should be sent. 1: added or removed from this capacity; 2: new comments are added; 3: new attachment is added; 4: attachment data is changed; 5: severity, priority, status, or milestone are changed; 6: resolved or reopened; 7: keywords change; 8: CC list changed; 0: any other change.<br><br>These are overridden and an email is not sent in the following circumstances, unless a suitable row is also present: 50: if the bug is unconfirmed; 51: if the change was by this user.<br><br>Global events are 100: a flag has been requested of this user; 101: This user has requested a flag.',
},
'fielddefs': {
'id': 'primary key for this table',
'name': 'field name or definition (some fields are names of other tables or of fields in other tables).',
'description': 'long description',
'mailhead': 'whether or not to send the field description in mail notifications.',
'sortkey': 'the order of fields in mail notifications.',
'obsolete': '1 if this field no longer exists, 0 otherwise.',
'type': ['The field type. 0 (FIELD_TYPE_UNKNOWN) for most non-custom fields.',
('2.23.1', None, '%(VERSION_STRING)s1 (FIELD_TYPE_FREETEXT) for a single-line text field. '),
('2.23.3', None, '%(VERSION_STRING)s2 (FIELD_TYPE_SINGLE_SELECT) for a single-select field. '),
('3.1.2', None, '%(VERSION_STRING)s3 (FIELD_TYPE_MULTI_SELECT) for a multi-select field. '),
('3.1.2', None, '%(VERSION_STRING)s4 (FIELD_TYPE_TEXTAREA) for a large text box field. '),
('3.1.3', None, '%(VERSION_STRING)s5 (FIELD_TYPE_DATETIME) for a date/time field. '),
('3.3.1', None, '%(VERSION_STRING)s6 (FIELD_TYPE_BUG_ID) for a bug ID field. '),
('3.3.2', None, '%(VERSION_STRING)s7 (FIELD_TYPE_BUG_URLS) for a list of bug URLs. '),
],
'custom': '1 for a custom field, 0 otherwise. Part of <a href="#notes-customfields">the custom fields system</a>.',
'enter_bug': '1 for a field which is present on the bug entry form, 0 otherwise.',
'buglist': '1 for a field which can be used as a display or order column in a bug list, 0 otherwise.',
'value_field_id': 'If not NULL, the ID of a (single-select or multi-select) <i>chooser field</i>, which controls the visibility of individual values of this field. Only applies to single-select and multi-select fields. Foreign ney %(column-fielddefs-id)s.',
'visibility_field_id': 'If not NULL, the ID of a (single-select or multi-select) <i>control field</i> which controls the visibility of this field. Only applies to custom fields. Foreign key %(column-fielddefs-id)s.',
'visibility_value_id': 'If not NULL, and the control field (with ID visibility_field_id) does not have a value with this ID, this field is not visible. Only applies to custom fields. Foreign key <field>.id, for example %(column-products-id)s or <a href="#column-customfield-id">cf_<field>.id</a>.',
},
'flagexclusions': {