-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
cascader.go
1270 lines (1195 loc) · 41 KB
/
cascader.go
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
// Copyright 2017 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package row
import (
"context"
"github.com/cockroachdb/cockroach/pkg/internal/client"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/sql/parser"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
"github.com/cockroachdb/cockroach/pkg/sql/rowcontainer"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/sql/sqlbase"
"github.com/cockroachdb/cockroach/pkg/util"
"github.com/cockroachdb/cockroach/pkg/util/errorutil/unimplemented"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/errors"
)
// cascader is used to handle all referential integrity cascading actions.
type cascader struct {
txn *client.Txn
fkTables FkTableMetadata
alloc *sqlbase.DatumAlloc
evalCtx *tree.EvalContext
indexPKRowFetchers map[TableID]map[sqlbase.IndexID]Fetcher // PK RowFetchers by Table ID and Index ID
// Row Deleters
rowDeleters map[TableID]Deleter // RowDeleters by Table ID
deleterRowFetchers map[TableID]Fetcher // RowFetchers for rowDeleters by Table ID
deletedRows map[TableID]*rowcontainer.RowContainer // Rows that have been deleted by Table ID
// Row Updaters
rowUpdaters map[TableID]Updater // RowUpdaters by Table ID
updaterRowFetchers map[TableID]Fetcher // RowFetchers for rowUpdaters by Table ID
originalRows map[TableID]*rowcontainer.RowContainer // Original values for rows that have been updated by Table ID
updatedRows map[TableID]*rowcontainer.RowContainer // New values for rows that have been updated by Table ID
}
// makeDeleteCascader only creates a cascader if there is a chance that there is
// a possible cascade. It returns a cascader if one is required and nil if not.
func makeDeleteCascader(
txn *client.Txn,
table *sqlbase.ImmutableTableDescriptor,
tablesByID FkTableMetadata,
evalCtx *tree.EvalContext,
alloc *sqlbase.DatumAlloc,
) (*cascader, error) {
if evalCtx == nil {
return nil, errors.AssertionFailedf("evalContext is nil")
}
var required bool
Outer:
for _, referencedIndex := range table.AllNonDropIndexes() {
for _, ref := range referencedIndex.ReferencedBy {
referencingTable, ok := tablesByID[ref.Table]
if !ok {
return nil, errors.AssertionFailedf("could not find table:%d in table descriptor map", ref.Table)
}
if referencingTable.IsAdding {
// We can assume that a table being added but not yet public is empty,
// and thus does not need to be checked for cascading.
continue
}
referencingIndex, err := referencingTable.Desc.FindIndexByID(ref.Index)
if err != nil {
return nil, err
}
if referencingIndex.ForeignKey.OnDelete == sqlbase.ForeignKeyReference_CASCADE ||
referencingIndex.ForeignKey.OnDelete == sqlbase.ForeignKeyReference_SET_DEFAULT ||
referencingIndex.ForeignKey.OnDelete == sqlbase.ForeignKeyReference_SET_NULL {
required = true
break Outer
}
}
}
if !required {
return nil, nil
}
return &cascader{
txn: txn,
fkTables: tablesByID,
indexPKRowFetchers: make(map[TableID]map[sqlbase.IndexID]Fetcher),
rowDeleters: make(map[TableID]Deleter),
deleterRowFetchers: make(map[TableID]Fetcher),
deletedRows: make(map[TableID]*rowcontainer.RowContainer),
rowUpdaters: make(map[TableID]Updater),
updaterRowFetchers: make(map[TableID]Fetcher),
originalRows: make(map[TableID]*rowcontainer.RowContainer),
updatedRows: make(map[TableID]*rowcontainer.RowContainer),
evalCtx: evalCtx,
alloc: alloc,
}, nil
}
// makeUpdateCascader only creates a cascader if there is a chance that there is
// a possible cascade. It returns a cascader if one is required and nil if not.
func makeUpdateCascader(
txn *client.Txn,
table *sqlbase.ImmutableTableDescriptor,
tablesByID FkTableMetadata,
updateCols []sqlbase.ColumnDescriptor,
evalCtx *tree.EvalContext,
alloc *sqlbase.DatumAlloc,
) (*cascader, error) {
if evalCtx == nil {
return nil, errors.AssertionFailedf("evalContext is nil")
}
var required bool
colIDs := make(map[sqlbase.ColumnID]struct{})
for i := range updateCols {
colIDs[updateCols[i].ID] = struct{}{}
}
Outer:
for _, referencedIndex := range table.AllNonDropIndexes() {
var match bool
for _, colID := range referencedIndex.ColumnIDs {
if _, exists := colIDs[colID]; exists {
match = true
break
}
}
if !match {
continue
}
for _, ref := range referencedIndex.ReferencedBy {
referencingTable, ok := tablesByID[ref.Table]
if !ok {
return nil, errors.AssertionFailedf("could not find table:%d in table descriptor map", ref.Table)
}
if referencingTable.IsAdding {
// We can assume that a table being added but not yet public is empty,
// and thus does not need to be checked for cascading.
continue
}
referencingIndex, err := referencingTable.Desc.FindIndexByID(ref.Index)
if err != nil {
return nil, err
}
if referencingIndex.ForeignKey.OnUpdate == sqlbase.ForeignKeyReference_CASCADE ||
referencingIndex.ForeignKey.OnUpdate == sqlbase.ForeignKeyReference_SET_DEFAULT ||
referencingIndex.ForeignKey.OnUpdate == sqlbase.ForeignKeyReference_SET_NULL {
required = true
break Outer
}
}
}
if !required {
return nil, nil
}
return &cascader{
txn: txn,
fkTables: tablesByID,
indexPKRowFetchers: make(map[TableID]map[sqlbase.IndexID]Fetcher),
rowDeleters: make(map[TableID]Deleter),
deleterRowFetchers: make(map[TableID]Fetcher),
deletedRows: make(map[TableID]*rowcontainer.RowContainer),
rowUpdaters: make(map[TableID]Updater),
updaterRowFetchers: make(map[TableID]Fetcher),
originalRows: make(map[TableID]*rowcontainer.RowContainer),
updatedRows: make(map[TableID]*rowcontainer.RowContainer),
evalCtx: evalCtx,
alloc: alloc,
}, nil
}
func (c *cascader) clear(ctx context.Context) {
for _, container := range c.deletedRows {
container.Clear(ctx)
}
for _, container := range c.originalRows {
container.Clear(ctx)
}
for _, container := range c.updatedRows {
container.Clear(ctx)
}
}
// spanForIndexValues creates a span against an index to extract the primary
// keys needed for cascading.
func spanForIndexValues(
table *sqlbase.ImmutableTableDescriptor,
index *sqlbase.IndexDescriptor,
prefixLen int,
match sqlbase.ForeignKeyReference_Match,
indexColIDs map[sqlbase.ColumnID]int,
values []tree.Datum,
keyPrefix []byte,
) (roachpb.Span, error) {
// See https://github.com/cockroachdb/cockroach/issues/20305 or
// https://www.postgresql.org/docs/11/sql-createtable.html for details on the
// different composite foreign key matching methods.
switch match {
case sqlbase.ForeignKeyReference_SIMPLE:
for _, rowIndex := range indexColIDs {
if values[rowIndex] == tree.DNull {
return roachpb.Span{}, nil
}
}
case sqlbase.ForeignKeyReference_FULL:
var nulls, notNulls bool
for _, rowIndex := range indexColIDs {
if values[rowIndex] == tree.DNull {
nulls = true
} else {
notNulls = true
}
if nulls && notNulls {
// TODO(bram): expand this error to show more details.
return roachpb.Span{}, pgerror.Newf(pgcode.ForeignKeyViolation,
"foreign key violation: MATCH FULL does not allow mixing of null and nonnull values %s",
values,
)
}
}
// Only if all the values are all null should we skip the FK check for
// MATCH FULL.
if nulls {
return roachpb.Span{}, nil
}
case sqlbase.ForeignKeyReference_PARTIAL:
return roachpb.Span{}, unimplemented.NewWithIssue(20305, "MATCH PARTIAL not supported")
default:
return roachpb.Span{}, errors.AssertionFailedf("unknown composite key match type: %v", match)
}
span, _, err := sqlbase.EncodePartialIndexSpan(table.TableDesc(), index, prefixLen, indexColIDs, values, keyPrefix)
if err != nil {
return roachpb.Span{}, err
}
return span, nil
}
// batchRequestForIndexValues creates a batch request against an index to
// extract the primary keys needed for cascading. It also returns the
// colIDtoRowIndex that will map the columns that have been retrieved as part of
// the request to the referencing table.
func batchRequestForIndexValues(
ctx context.Context,
referencedIndex *sqlbase.IndexDescriptor,
referencingTable *sqlbase.ImmutableTableDescriptor,
referencingIndex *sqlbase.IndexDescriptor,
match sqlbase.ForeignKeyReference_Match,
values cascadeQueueElement,
traceKV bool,
) (roachpb.BatchRequest, map[sqlbase.ColumnID]int, error) {
//TODO(bram): consider caching some of these values
keyPrefix := sqlbase.MakeIndexKeyPrefix(referencingTable.TableDesc(), referencingIndex.ID)
prefixLen := len(referencingIndex.ColumnIDs)
if len(referencedIndex.ColumnIDs) < prefixLen {
prefixLen = len(referencedIndex.ColumnIDs)
}
colIDtoRowIndex := make(map[sqlbase.ColumnID]int, len(referencedIndex.ColumnIDs))
for i, referencedColID := range referencedIndex.ColumnIDs[:prefixLen] {
if found, ok := values.colIDtoRowIndex[referencedColID]; ok {
colIDtoRowIndex[referencingIndex.ColumnIDs[i]] = found
} else {
return roachpb.BatchRequest{}, nil, pgerror.Newf(pgcode.ForeignKeyViolation,
"missing value for column %q in multi-part foreign key", referencedIndex.ColumnNames[i],
)
}
}
var req roachpb.BatchRequest
for i := values.startIndex; i < values.endIndex; i++ {
span, err := spanForIndexValues(
referencingTable,
referencingIndex,
prefixLen,
match,
colIDtoRowIndex,
values.originalValues.At(i),
keyPrefix,
)
if err != nil {
return roachpb.BatchRequest{}, nil, err
}
if span.EndKey != nil {
req.Add(&roachpb.ScanRequest{RequestHeader: roachpb.RequestHeaderFromSpan(span)})
if traceKV {
log.VEventf(ctx, 2, "CascadeScan %s", span)
}
}
}
return req, colIDtoRowIndex, nil
}
// spanForPKValues creates a span against the primary index of a table and is
// used to fetch rows for cascading.
func spanForPKValues(
table *sqlbase.ImmutableTableDescriptor,
fetchColIDtoRowIndex map[sqlbase.ColumnID]int,
values tree.Datums,
) (roachpb.Span, error) {
return spanForIndexValues(
table,
&table.PrimaryIndex,
len(table.PrimaryIndex.ColumnIDs),
sqlbase.ForeignKeyReference_SIMPLE, /* primary key lookup can always use MATCH SIMPLE */
fetchColIDtoRowIndex,
values,
sqlbase.MakeIndexKeyPrefix(table.TableDesc(), table.PrimaryIndex.ID),
)
}
// batchRequestForPKValues creates a batch request against the primary index of
// a table and is used to fetch rows for cascading.
func batchRequestForPKValues(
ctx context.Context,
table *sqlbase.ImmutableTableDescriptor,
fetchColIDtoRowIndex map[sqlbase.ColumnID]int,
values *rowcontainer.RowContainer,
traceKV bool,
) (roachpb.BatchRequest, error) {
var req roachpb.BatchRequest
for i := 0; i < values.Len(); i++ {
span, err := spanForPKValues(table, fetchColIDtoRowIndex, values.At(i))
if err != nil {
return roachpb.BatchRequest{}, err
}
if span.EndKey != nil {
if traceKV {
log.VEventf(ctx, 2, "CascadeScan %s", span)
}
req.Add(&roachpb.ScanRequest{RequestHeader: roachpb.RequestHeaderFromSpan(span)})
}
}
return req, nil
}
// addIndexPKRowFetch will create or load a cached row fetcher on an index to
// fetch the primary keys of the rows that will be affected by a cascading
// action.
func (c *cascader) addIndexPKRowFetcher(
table *sqlbase.ImmutableTableDescriptor, index *sqlbase.IndexDescriptor,
) (Fetcher, error) {
// Is there a cached row fetcher?
rowFetchersForTable, exists := c.indexPKRowFetchers[table.ID]
if exists {
rowFetcher, exists := rowFetchersForTable[index.ID]
if exists {
return rowFetcher, nil
}
} else {
c.indexPKRowFetchers[table.ID] = make(map[sqlbase.IndexID]Fetcher)
}
// Create a new row fetcher. Only the primary key columns are required.
var colDesc []sqlbase.ColumnDescriptor
for _, id := range table.PrimaryIndex.ColumnIDs {
cDesc, err := table.FindColumnByID(id)
if err != nil {
return Fetcher{}, err
}
colDesc = append(colDesc, *cDesc)
}
var valNeededForCol util.FastIntSet
valNeededForCol.AddRange(0, len(colDesc)-1)
isSecondary := table.PrimaryIndex.ID != index.ID
var rowFetcher Fetcher
if err := rowFetcher.Init(
false, /* reverse */
false, /* returnRangeInfo */
false, /* isCheck */
c.alloc,
FetcherTableArgs{
Desc: table,
Index: index,
ColIdxMap: ColIDtoRowIndexFromCols(colDesc),
IsSecondaryIndex: isSecondary,
Cols: colDesc,
ValNeededForCol: valNeededForCol,
},
); err != nil {
return Fetcher{}, err
}
// Cache the row fetcher.
c.indexPKRowFetchers[table.ID][index.ID] = rowFetcher
return rowFetcher, nil
}
// addRowDeleter creates the row deleter and primary index row fetcher.
func (c *cascader) addRowDeleter(
table *sqlbase.ImmutableTableDescriptor,
) (Deleter, Fetcher, error) {
// Is there a cached row fetcher and deleter?
if rowDeleter, exists := c.rowDeleters[table.ID]; exists {
rowFetcher, existsFetcher := c.deleterRowFetchers[table.ID]
if !existsFetcher {
return Deleter{}, Fetcher{}, errors.AssertionFailedf("no corresponding row fetcher for the row deleter for table: (%d)%s",
table.ID, table.Name,
)
}
return rowDeleter, rowFetcher, nil
}
// Create the row deleter. The row deleter is needed prior to the row fetcher
// as it will dictate what columns are required in the row fetcher.
rowDeleter, err := makeRowDeleterWithoutCascader(
c.txn,
table,
c.fkTables,
nil, /* requestedCol */
CheckFKs,
c.alloc,
)
if err != nil {
return Deleter{}, Fetcher{}, err
}
// Create the row fetcher that will retrive the rows and columns needed for
// deletion.
var valNeededForCol util.FastIntSet
valNeededForCol.AddRange(0, len(rowDeleter.FetchCols)-1)
tableArgs := FetcherTableArgs{
Desc: table,
Index: &table.PrimaryIndex,
ColIdxMap: rowDeleter.FetchColIDtoRowIndex,
IsSecondaryIndex: false,
Cols: rowDeleter.FetchCols,
ValNeededForCol: valNeededForCol,
}
var rowFetcher Fetcher
if err := rowFetcher.Init(
false, /* reverse */
false, /* returnRangeInfo */
false, /* isCheck */
c.alloc,
tableArgs,
); err != nil {
return Deleter{}, Fetcher{}, err
}
// Cache both the fetcher and deleter.
c.rowDeleters[table.ID] = rowDeleter
c.deleterRowFetchers[table.ID] = rowFetcher
return rowDeleter, rowFetcher, nil
}
// addRowUpdater creates the row updater and primary index row fetcher.
func (c *cascader) addRowUpdater(
table *sqlbase.ImmutableTableDescriptor,
) (Updater, Fetcher, error) {
// Is there a cached updater?
rowUpdater, existsUpdater := c.rowUpdaters[table.ID]
if existsUpdater {
rowFetcher, existsFetcher := c.updaterRowFetchers[table.ID]
if !existsFetcher {
return Updater{}, Fetcher{}, errors.AssertionFailedf("no corresponding row fetcher for the row updater for table: (%d)%s",
table.ID, table.Name,
)
}
return rowUpdater, rowFetcher, nil
}
// Create the row updater. The row updater requires all the columns in the
// table.
rowUpdater, err := makeUpdaterWithoutCascader(
c.txn,
table,
c.fkTables,
table.Columns,
nil, /* requestedCol */
UpdaterDefault,
c.alloc,
)
if err != nil {
return Updater{}, Fetcher{}, err
}
// Create the row fetcher that will retrive the rows and columns needed for
// deletion.
var valNeededForCol util.FastIntSet
valNeededForCol.AddRange(0, len(rowUpdater.FetchCols)-1)
tableArgs := FetcherTableArgs{
Desc: table,
Index: &table.PrimaryIndex,
ColIdxMap: rowUpdater.FetchColIDtoRowIndex,
IsSecondaryIndex: false,
Cols: rowUpdater.FetchCols,
ValNeededForCol: valNeededForCol,
}
var rowFetcher Fetcher
if err := rowFetcher.Init(
false, /* reverse */
false, /* returnRangeInfo */
false, /* isCheck */
c.alloc,
tableArgs,
); err != nil {
return Updater{}, Fetcher{}, err
}
// Cache the updater and the fetcher.
c.rowUpdaters[table.ID] = rowUpdater
c.updaterRowFetchers[table.ID] = rowFetcher
return rowUpdater, rowFetcher, nil
}
// deleteRows performs row deletions on a single table for all rows that match
// the values. Returns the values of the rows that were deleted. This deletion
// happens in a single batch.
func (c *cascader) deleteRows(
ctx context.Context,
referencedIndex *sqlbase.IndexDescriptor,
referencingTable *sqlbase.ImmutableTableDescriptor,
referencingIndex *sqlbase.IndexDescriptor,
match sqlbase.ForeignKeyReference_Match,
values cascadeQueueElement,
traceKV bool,
) (*rowcontainer.RowContainer, map[sqlbase.ColumnID]int, int, error) {
// Create the span to search for index values.
// TODO(bram): This initial index lookup can be skipped if the index is the
// primary index.
if traceKV {
log.VEventf(ctx, 2, "cascading delete into table: %d using index: %d",
referencingTable.ID, referencingIndex.ID,
)
}
req, _, err := batchRequestForIndexValues(
ctx, referencedIndex, referencingTable, referencingIndex, match, values, traceKV,
)
if err != nil {
return nil, nil, 0, err
}
// If there are no spans to search, there is no need to cascade.
if len(req.Requests) == 0 {
return nil, nil, 0, nil
}
br, roachErr := c.txn.Send(ctx, req)
if roachErr != nil {
return nil, nil, 0, roachErr.GoError()
}
// Create or retrieve the index pk row fetcher.
indexPKRowFetcher, err := c.addIndexPKRowFetcher(referencingTable, referencingIndex)
if err != nil {
return nil, nil, 0, err
}
indexPKRowFetcherColIDToRowIndex := indexPKRowFetcher.tables[0].colIdxMap
// Fetch all the primary keys that need to be deleted.
// TODO(Bram): consider chunking this into n, primary keys, perhaps 100.
pkColTypeInfo, err := sqlbase.MakeColTypeInfo(referencingTable, indexPKRowFetcherColIDToRowIndex)
if err != nil {
return nil, nil, 0, err
}
primaryKeysToDelete := rowcontainer.NewRowContainer(
c.evalCtx.Mon.MakeBoundAccount(), pkColTypeInfo, values.originalValues.Len(),
)
defer primaryKeysToDelete.Close(ctx)
for _, resp := range br.Responses {
fetcher := SpanKVFetcher{
KVs: resp.GetInner().(*roachpb.ScanResponse).Rows,
}
if err := indexPKRowFetcher.StartScanFrom(ctx, &fetcher); err != nil {
return nil, nil, 0, err
}
for !indexPKRowFetcher.kvEnd {
primaryKey, _, _, err := indexPKRowFetcher.NextRowDecoded(ctx)
if err != nil {
return nil, nil, 0, err
}
if _, err := primaryKeysToDelete.AddRow(ctx, primaryKey); err != nil {
return nil, nil, 0, err
}
}
}
// Early exit if no rows need to be deleted.
if primaryKeysToDelete.Len() == 0 {
return nil, nil, 0, nil
}
// Create or retrieve the row deleter and primary index row fetcher.
rowDeleter, pkRowFetcher, err := c.addRowDeleter(referencingTable)
if err != nil {
return nil, nil, 0, err
}
// Create a batch request to get all the spans of the primary keys that need
// to be deleted.
pkLookupReq, err := batchRequestForPKValues(
ctx, referencingTable, indexPKRowFetcherColIDToRowIndex, primaryKeysToDelete, traceKV,
)
if err != nil {
return nil, nil, 0, err
}
primaryKeysToDelete.Clear(ctx)
// If there are no spans to search, there is no need to cascade.
if len(pkLookupReq.Requests) == 0 {
return nil, nil, 0, nil
}
pkResp, roachErr := c.txn.Send(ctx, pkLookupReq)
if roachErr != nil {
return nil, nil, 0, roachErr.GoError()
}
// Add the values to be checked for constraint violations after all cascading
// changes have completed. Here either fetch or create the deleted rows
// rowContainer for the table. This rowContainer for the table is also used by
// the queue to avoid having to double the memory used.
if _, exists := c.deletedRows[referencingTable.ID]; !exists {
// Fetch the rows for deletion and store them in a container.
colTypeInfo, err := sqlbase.MakeColTypeInfo(referencingTable, rowDeleter.FetchColIDtoRowIndex)
if err != nil {
return nil, nil, 0, err
}
c.deletedRows[referencingTable.ID] = rowcontainer.NewRowContainer(
c.evalCtx.Mon.MakeBoundAccount(), colTypeInfo, primaryKeysToDelete.Len(),
)
}
deletedRows := c.deletedRows[referencingTable.ID]
deletedRowsStartIndex := deletedRows.Len()
// Delete all the rows in a new batch.
batch := c.txn.NewBatch()
for _, resp := range pkResp.Responses {
fetcher := SpanKVFetcher{
KVs: resp.GetInner().(*roachpb.ScanResponse).Rows,
}
if err := pkRowFetcher.StartScanFrom(ctx, &fetcher); err != nil {
return nil, nil, 0, err
}
for !pkRowFetcher.kvEnd {
rowToDelete, _, _, err := pkRowFetcher.NextRowDecoded(ctx)
if err != nil {
return nil, nil, 0, err
}
// Add the row to be checked for consistency changes.
if _, err := deletedRows.AddRow(ctx, rowToDelete); err != nil {
return nil, nil, 0, err
}
// Delete the row.
if err := rowDeleter.DeleteRow(ctx, batch, rowToDelete, SkipFKs, traceKV); err != nil {
return nil, nil, 0, err
}
}
}
// Run the batch.
if err := c.txn.Run(ctx, batch); err != nil {
return nil, nil, 0, ConvertBatchError(ctx, referencingTable, batch)
}
return deletedRows, rowDeleter.FetchColIDtoRowIndex, deletedRowsStartIndex, nil
}
// updateRows performs row updates on a single table for all rows that match
// the values. Returns both the values of the rows that were updated and their
// new values. This update happens in a single batch.
func (c *cascader) updateRows(
ctx context.Context,
referencedIndex *sqlbase.IndexDescriptor,
referencingTable *sqlbase.ImmutableTableDescriptor,
referencingIndex *sqlbase.IndexDescriptor,
match sqlbase.ForeignKeyReference_Match,
values cascadeQueueElement,
action sqlbase.ForeignKeyReference_Action,
traceKV bool,
) (*rowcontainer.RowContainer, *rowcontainer.RowContainer, map[sqlbase.ColumnID]int, int, error) {
// Create the span to search for index values.
if traceKV {
log.VEventf(ctx, 2, "cascading update into table: %d using index: %d",
referencingTable.ID, referencingIndex.ID,
)
}
// Create or retrieve the row updater and row fetcher.
rowUpdater, rowFetcher, err := c.addRowUpdater(referencingTable)
if err != nil {
return nil, nil, nil, 0, err
}
// Add the values to be checked for constraint violations after all cascading
// changes have completed. Here either fetch or create the rowContainers for
// both the original and updated values for the table and index combo. These
// rowContainers for are also used by the queue to avoid having to double the
// memory used.
if _, exists := c.originalRows[referencingTable.ID]; !exists {
colTypeInfo, err := sqlbase.MakeColTypeInfo(referencingTable, rowUpdater.FetchColIDtoRowIndex)
if err != nil {
return nil, nil, nil, 0, err
}
c.originalRows[referencingTable.ID] = rowcontainer.NewRowContainer(
c.evalCtx.Mon.MakeBoundAccount(), colTypeInfo, values.originalValues.Len(),
)
c.updatedRows[referencingTable.ID] = rowcontainer.NewRowContainer(
c.evalCtx.Mon.MakeBoundAccount(), colTypeInfo, values.originalValues.Len(),
)
}
originalRows := c.originalRows[referencingTable.ID]
updatedRows := c.updatedRows[referencingTable.ID]
startIndex := originalRows.Len()
// Update all the rows in a new batch.
batch := c.txn.NewBatch()
// Populate a map of all columns that need to be set if the action is not
// cascade.
var referencingIndexValuesByColIDs map[sqlbase.ColumnID]tree.Datum
switch action {
case sqlbase.ForeignKeyReference_SET_NULL:
referencingIndexValuesByColIDs = make(map[sqlbase.ColumnID]tree.Datum)
for _, columnID := range referencingIndex.ColumnIDs {
referencingIndexValuesByColIDs[columnID] = tree.DNull
}
case sqlbase.ForeignKeyReference_SET_DEFAULT:
referencingIndexValuesByColIDs = make(map[sqlbase.ColumnID]tree.Datum)
for _, columnID := range referencingIndex.ColumnIDs {
column, err := referencingTable.FindColumnByID(columnID)
if err != nil {
return nil, nil, nil, 0, err
}
// If the default expression is nil, treat it as a SET NULL case
if column.DefaultExpr == nil {
referencingIndexValuesByColIDs[columnID] = tree.DNull
continue
}
parsedExpr, err := parser.ParseExpr(*column.DefaultExpr)
if err != nil {
return nil, nil, nil, 0, err
}
typedExpr, err := tree.TypeCheck(parsedExpr, nil, &column.Type)
if err != nil {
return nil, nil, nil, 0, err
}
normalizedExpr, err := c.evalCtx.NormalizeExpr(typedExpr)
if err != nil {
return nil, nil, nil, 0, err
}
referencingIndexValuesByColIDs[columnID], err = normalizedExpr.Eval(c.evalCtx)
if err != nil {
return nil, nil, nil, 0, err
}
}
}
// Sadly, this operation cannot be batched the same way as deletes, as the
// values being updated will change based on both the original and updated
// values.
for i := values.startIndex; i < values.endIndex; i++ {
// Extract a single value to update at a time.
req, valueColIDtoRowIndex, err := batchRequestForIndexValues(
ctx, referencedIndex, referencingTable, referencingIndex, match, cascadeQueueElement{
startIndex: i,
endIndex: i + 1,
originalValues: values.originalValues,
updatedValues: values.updatedValues,
table: values.table,
colIDtoRowIndex: values.colIDtoRowIndex,
},
traceKV,
)
if err != nil {
return nil, nil, nil, 0, err
}
// If there are no spans to search, there is no need to cascade.
if len(req.Requests) == 0 {
return nil, nil, nil, 0, nil
}
br, roachErr := c.txn.Send(ctx, req)
if roachErr != nil {
return nil, nil, nil, 0, roachErr.GoError()
}
// Create or retrieve the index pk row fetcher.
indexPKRowFetcher, err := c.addIndexPKRowFetcher(referencingTable, referencingIndex)
if err != nil {
return nil, nil, nil, 0, err
}
indexPKRowFetcherColIDToRowIndex := indexPKRowFetcher.tables[0].colIdxMap
// Fetch all the primary keys for rows that will be updated.
// TODO(Bram): consider chunking this into n, primary keys, perhaps 100.
pkColTypeInfo, err := sqlbase.MakeColTypeInfo(referencingTable, indexPKRowFetcherColIDToRowIndex)
if err != nil {
return nil, nil, nil, 0, err
}
primaryKeysToUpdate := rowcontainer.NewRowContainer(
c.evalCtx.Mon.MakeBoundAccount(), pkColTypeInfo, values.originalValues.Len(),
)
defer primaryKeysToUpdate.Close(ctx)
for _, resp := range br.Responses {
fetcher := SpanKVFetcher{
KVs: resp.GetInner().(*roachpb.ScanResponse).Rows,
}
if err := indexPKRowFetcher.StartScanFrom(ctx, &fetcher); err != nil {
return nil, nil, nil, 0, err
}
for !indexPKRowFetcher.kvEnd {
primaryKey, _, _, err := indexPKRowFetcher.NextRowDecoded(ctx)
if err != nil {
return nil, nil, nil, 0, err
}
if _, err := primaryKeysToUpdate.AddRow(ctx, primaryKey); err != nil {
return nil, nil, nil, 0, err
}
}
}
// Early exit if no rows need to be updated.
if primaryKeysToUpdate.Len() == 0 {
continue
}
// Create a batch request to get all the spans of the primary keys that need
// to be updated.
pkLookupReq, err := batchRequestForPKValues(
ctx, referencingTable, indexPKRowFetcherColIDToRowIndex, primaryKeysToUpdate, traceKV,
)
if err != nil {
return nil, nil, nil, 0, err
}
primaryKeysToUpdate.Clear(ctx)
// If there are no spans to search, there is no need to cascade.
if len(pkLookupReq.Requests) == 0 {
return nil, nil, nil, 0, nil
}
pkResp, roachErr := c.txn.Send(ctx, pkLookupReq)
if roachErr != nil {
return nil, nil, nil, 0, roachErr.GoError()
}
for _, resp := range pkResp.Responses {
fetcher := SpanKVFetcher{
KVs: resp.GetInner().(*roachpb.ScanResponse).Rows,
}
if err := rowFetcher.StartScanFrom(ctx, &fetcher); err != nil {
return nil, nil, nil, 0, err
}
for !rowFetcher.kvEnd {
rowToUpdate, _, _, err := rowFetcher.NextRowDecoded(ctx)
if err != nil {
return nil, nil, nil, 0, err
}
updateRow := make(tree.Datums, len(rowUpdater.UpdateColIDtoRowIndex))
switch action {
case sqlbase.ForeignKeyReference_CASCADE:
// Create the updateRow based on the passed in updated values and from
// the retrieved row as a fallback.
currentUpdatedValue := values.updatedValues.At(i)
for colID, rowIndex := range rowUpdater.UpdateColIDtoRowIndex {
if valueRowIndex, exists := valueColIDtoRowIndex[colID]; exists {
updateRow[rowIndex] = currentUpdatedValue[valueRowIndex]
if updateRow[rowIndex] == tree.DNull {
column, err := referencingTable.FindColumnByID(colID)
if err != nil {
return nil, nil, nil, 0, err
}
if !column.Nullable {
database, err := sqlbase.GetDatabaseDescFromID(ctx, c.txn, referencingTable.ParentID)
if err != nil {
return nil, nil, nil, 0, err
}
return nil, nil, nil, 0, pgerror.Newf(pgcode.NullValueNotAllowed,
"cannot cascade a null value into %q as it violates a NOT NULL constraint",
tree.ErrString(tree.NewUnresolvedName(database.Name, tree.PublicSchema, referencingTable.Name, column.Name)))
}
}
continue
}
if fetchRowIndex, exists := rowUpdater.FetchColIDtoRowIndex[colID]; exists {
updateRow[rowIndex] = rowToUpdate[fetchRowIndex]
continue
}
return nil, nil, nil, 0, errors.AssertionFailedf("could find find colID %d in either updated columns or the fetched row",
colID,
)
}
case sqlbase.ForeignKeyReference_SET_NULL, sqlbase.ForeignKeyReference_SET_DEFAULT:
// Create the updateRow based on the original values and for all
// values in the index, either nulls (for SET NULL), or default (for
// SET DEFAULT).
for colID, rowIndex := range rowUpdater.UpdateColIDtoRowIndex {
if value, exists := referencingIndexValuesByColIDs[colID]; exists {
updateRow[rowIndex] = value
continue
}
if fetchRowIndex, exists := rowUpdater.FetchColIDtoRowIndex[colID]; exists {
updateRow[rowIndex] = rowToUpdate[fetchRowIndex]
continue
}
return nil, nil, nil, 0, errors.AssertionFailedf("could find find colID %d in either the index columns or the fetched row",
colID,
)
}
}
// Is there something to update? If not, skip it.
if !rowToUpdate.IsDistinctFrom(c.evalCtx, updateRow) {
continue
}
updatedRow, err := rowUpdater.UpdateRow(
ctx,
batch,
rowToUpdate,
updateRow,
SkipFKs,
traceKV,
)
if err != nil {
return nil, nil, nil, 0, err
}
if _, err := originalRows.AddRow(ctx, rowToUpdate); err != nil {
return nil, nil, nil, 0, err
}
if _, err := updatedRows.AddRow(ctx, updatedRow); err != nil {
return nil, nil, nil, 0, err
}
}
}
}
if err := c.txn.Run(ctx, batch); err != nil {
return nil, nil, nil, 0, ConvertBatchError(ctx, referencingTable, batch)
}
return originalRows, updatedRows, rowUpdater.FetchColIDtoRowIndex, startIndex, nil
}
type cascadeQueueElement struct {
table *sqlbase.ImmutableTableDescriptor
// These row containers are defined elsewhere and their memory is not managed
// by the queue. The updated values can be nil for deleted rows. If it does
// exist, every row in originalValues must have a corresponding row in
// updatedValues at the exact same index. They also must have the exact same
// rank.
originalValues *rowcontainer.RowContainer
updatedValues *rowcontainer.RowContainer
colIDtoRowIndex map[sqlbase.ColumnID]int
startIndex int // Start of the range of rows in the row container.
endIndex int // End of the range of rows (exclusive) in the row container.
}
// cascadeQueue is used for a breadth first walk of the referential integrity
// graph.
type cascadeQueue []cascadeQueueElement
// Enqueue adds a range of values in a row container to the queue. Note that
// it always assumes that all the values start at the startIndex and extend to
// all the rows following that index.
func (q *cascadeQueue) enqueue(
ctx context.Context,
table *sqlbase.ImmutableTableDescriptor,
originalValues *rowcontainer.RowContainer,
updatedValues *rowcontainer.RowContainer,
colIDtoRowIndex map[sqlbase.ColumnID]int,
startIndex int,
) error {
*q = append(*q, cascadeQueueElement{
table: table,
originalValues: originalValues,
updatedValues: updatedValues,
colIDtoRowIndex: colIDtoRowIndex,
startIndex: startIndex,
endIndex: originalValues.Len(),
})
return nil
}
func (q *cascadeQueue) dequeue() (cascadeQueueElement, bool) {
if len(*q) == 0 {
return cascadeQueueElement{}, false
}
elem := (*q)[0]
*q = (*q)[1:]
return elem, true
}
// cascadeAll performs all required cascading operations, then checks all the
// remaining indexes to ensure that no orphans were created.
func (c *cascader) cascadeAll(
ctx context.Context,
table *sqlbase.ImmutableTableDescriptor,
originalValues tree.Datums,
updatedValues tree.Datums,
colIDtoRowIndex map[sqlbase.ColumnID]int,
traceKV bool,
) error {