/
foreign_key.go
469 lines (435 loc) · 14.3 KB
/
foreign_key.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
// Copyright 2022 PingCAP, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package core
import (
"fmt"
"unsafe"
"github.com/pingcap/errors"
"github.com/wuhuizuo/tidb6/infoschema"
"github.com/wuhuizuo/tidb6/parser/model"
"github.com/wuhuizuo/tidb6/parser/mysql"
"github.com/wuhuizuo/tidb6/sessionctx"
"github.com/wuhuizuo/tidb6/table"
)
// FKCheck indicates the foreign key constraint checker.
type FKCheck struct {
basePhysicalPlan
FK *model.FKInfo
ReferredFK *model.ReferredFKInfo
Tbl table.Table
Idx table.Index
Cols []model.CIStr
IdxIsPrimaryKey bool
IdxIsExclusive bool
CheckExist bool
FailedErr error
}
// FKCascade indicates the foreign key constraint cascade behaviour.
type FKCascade struct {
basePhysicalPlan
Tp FKCascadeType
ReferredFK *model.ReferredFKInfo
ChildTable table.Table
FK *model.FKInfo
FKCols []*model.ColumnInfo
FKIdx *model.IndexInfo
// CascadePlans contains the child cascade plan.
// CascadePlans will be filled during execution, so only `explain analyze` statement result contains the cascade plan,
// `explain` statement result doesn't contain the cascade plan.
CascadePlans []Plan
}
// FKCascadeType indicates in which (delete/update) statements.
type FKCascadeType int8
const (
// FKCascadeOnDelete indicates in delete statement.
FKCascadeOnDelete FKCascadeType = 1
// FKCascadeOnUpdate indicates in update statement.
FKCascadeOnUpdate FKCascadeType = 2
emptyFkCheckSize = int64(unsafe.Sizeof(FKCheck{}))
emptyFkCascadeSize = int64(unsafe.Sizeof(FKCascade{}))
)
// AccessObject implements dataAccesser interface.
func (f *FKCheck) AccessObject() AccessObject {
if f.Idx == nil {
return OtherAccessObject(fmt.Sprintf("table:%s", f.Tbl.Meta().Name))
}
return OtherAccessObject(fmt.Sprintf("table:%s, index:%s", f.Tbl.Meta().Name, f.Idx.Meta().Name))
}
// OperatorInfo implements dataAccesser interface.
func (f *FKCheck) OperatorInfo(normalized bool) string {
if f.FK != nil {
return fmt.Sprintf("foreign_key:%s, check_exist", f.FK.Name)
}
if f.ReferredFK != nil {
return fmt.Sprintf("foreign_key:%s, check_not_exist", f.ReferredFK.ChildFKName)
}
return ""
}
// ExplainInfo implement Plan interface.
func (f *FKCheck) ExplainInfo() string {
return f.AccessObject().String() + ", " + f.OperatorInfo(false)
}
// MemoryUsage return the memory usage of FKCheck
func (f *FKCheck) MemoryUsage() (sum int64) {
if f == nil {
return
}
sum = emptyFkCheckSize
for _, cis := range f.Cols {
sum += cis.MemoryUsage()
}
return
}
// AccessObject implements dataAccesser interface.
func (f *FKCascade) AccessObject() AccessObject {
if f.FKIdx == nil {
return OtherAccessObject(fmt.Sprintf("table:%s", f.ChildTable.Meta().Name))
}
return OtherAccessObject(fmt.Sprintf("table:%s, index:%s", f.ChildTable.Meta().Name, f.FKIdx.Name))
}
// OperatorInfo implements dataAccesser interface.
func (f *FKCascade) OperatorInfo(normalized bool) string {
switch f.Tp {
case FKCascadeOnDelete:
return fmt.Sprintf("foreign_key:%s, on_delete:%s", f.FK.Name, model.ReferOptionType(f.FK.OnDelete).String())
case FKCascadeOnUpdate:
return fmt.Sprintf("foreign_key:%s, on_update:%s", f.FK.Name, model.ReferOptionType(f.FK.OnUpdate).String())
}
return ""
}
// ExplainInfo implement Plan interface.
func (f *FKCascade) ExplainInfo() string {
return f.AccessObject().String() + ", " + f.OperatorInfo(false)
}
// MemoryUsage return the memory usage of FKCascade
func (f *FKCascade) MemoryUsage() (sum int64) {
if f == nil {
return
}
sum = emptyFkCascadeSize
return
}
func (p *Insert) buildOnInsertFKTriggers(ctx sessionctx.Context, is infoschema.InfoSchema, dbName string) error {
if !ctx.GetSessionVars().ForeignKeyChecks {
return nil
}
tblInfo := p.Table.Meta()
fkChecks := make([]*FKCheck, 0, len(tblInfo.ForeignKeys))
fkCascades := make([]*FKCascade, 0, len(tblInfo.ForeignKeys))
updateCols := p.buildOnDuplicateUpdateColumns()
if len(updateCols) > 0 {
referredFKChecks, referredFKCascades, err := buildOnUpdateReferredFKTriggers(ctx, is, dbName, tblInfo, updateCols)
if err != nil {
return err
}
if len(referredFKChecks) > 0 {
fkChecks = append(fkChecks, referredFKChecks...)
}
if len(referredFKCascades) > 0 {
fkCascades = append(fkCascades, referredFKCascades...)
}
}
for _, fk := range tblInfo.ForeignKeys {
if fk.Version < 1 {
continue
}
failedErr := ErrNoReferencedRow2.FastGenByArgs(fk.String(dbName, tblInfo.Name.L))
fkCheck, err := buildFKCheckOnModifyChildTable(ctx, is, fk, failedErr)
if err != nil {
return err
}
if fkCheck != nil {
fkChecks = append(fkChecks, fkCheck)
}
}
p.FKChecks = fkChecks
p.FKCascades = fkCascades
return nil
}
func (p *Insert) buildOnDuplicateUpdateColumns() map[string]struct{} {
m := make(map[string]struct{})
for _, assign := range p.OnDuplicate {
m[assign.ColName.L] = struct{}{}
}
return m
}
func (updt *Update) buildOnUpdateFKTriggers(ctx sessionctx.Context, is infoschema.InfoSchema, tblID2table map[int64]table.Table) error {
if !ctx.GetSessionVars().ForeignKeyChecks {
return nil
}
tblID2UpdateColumns := updt.buildTbl2UpdateColumns()
fkChecks := make(map[int64][]*FKCheck)
fkCascades := make(map[int64][]*FKCascade)
for tid, tbl := range tblID2table {
tblInfo := tbl.Meta()
dbInfo, exist := is.SchemaByTable(tblInfo)
if !exist {
// Normally, it should never happen. Just check here to avoid panic here.
return infoschema.ErrDatabaseNotExists
}
updateCols := tblID2UpdateColumns[tid]
if len(updateCols) == 0 {
continue
}
referredFKChecks, referredFKCascades, err := buildOnUpdateReferredFKTriggers(ctx, is, dbInfo.Name.L, tblInfo, updateCols)
if err != nil {
return err
}
if len(referredFKChecks) > 0 {
fkChecks[tid] = append(fkChecks[tid], referredFKChecks...)
}
if len(referredFKCascades) > 0 {
fkCascades[tid] = append(fkCascades[tid], referredFKCascades...)
}
childFKChecks, err := buildOnUpdateChildFKChecks(ctx, is, dbInfo.Name.L, tblInfo, updateCols)
if err != nil {
return err
}
if len(childFKChecks) > 0 {
fkChecks[tid] = append(fkChecks[tid], childFKChecks...)
}
}
updt.FKChecks = fkChecks
updt.FKCascades = fkCascades
return nil
}
func (del *Delete) buildOnDeleteFKTriggers(ctx sessionctx.Context, is infoschema.InfoSchema, tblID2table map[int64]table.Table) error {
if !ctx.GetSessionVars().ForeignKeyChecks {
return nil
}
fkChecks := make(map[int64][]*FKCheck)
fkCascades := make(map[int64][]*FKCascade)
for tid, tbl := range tblID2table {
tblInfo := tbl.Meta()
dbInfo, exist := is.SchemaByTable(tblInfo)
if !exist {
return infoschema.ErrDatabaseNotExists
}
referredFKs := is.GetTableReferredForeignKeys(dbInfo.Name.L, tblInfo.Name.L)
for _, referredFK := range referredFKs {
fkCheck, fkCascade, err := buildOnDeleteOrUpdateFKTrigger(ctx, is, referredFK, FKCascadeOnDelete)
if err != nil {
return err
}
if fkCheck != nil {
fkChecks[tid] = append(fkChecks[tid], fkCheck)
}
if fkCascade != nil {
fkCascades[tid] = append(fkCascades[tid], fkCascade)
}
}
}
del.FKChecks = fkChecks
del.FKCascades = fkCascades
return nil
}
func buildOnUpdateReferredFKTriggers(ctx sessionctx.Context, is infoschema.InfoSchema, dbName string, tblInfo *model.TableInfo, updateCols map[string]struct{}) ([]*FKCheck, []*FKCascade, error) {
referredFKs := is.GetTableReferredForeignKeys(dbName, tblInfo.Name.L)
fkChecks := make([]*FKCheck, 0, len(referredFKs))
fkCascades := make([]*FKCascade, 0, len(referredFKs))
for _, referredFK := range referredFKs {
if !isMapContainAnyCols(updateCols, referredFK.Cols...) {
continue
}
fkCheck, fkCascade, err := buildOnDeleteOrUpdateFKTrigger(ctx, is, referredFK, FKCascadeOnUpdate)
if err != nil {
return nil, nil, err
}
if fkCheck != nil {
fkChecks = append(fkChecks, fkCheck)
}
if fkCascade != nil {
fkCascades = append(fkCascades, fkCascade)
}
}
return fkChecks, fkCascades, nil
}
func buildOnUpdateChildFKChecks(ctx sessionctx.Context, is infoschema.InfoSchema, dbName string, tblInfo *model.TableInfo, updateCols map[string]struct{}) ([]*FKCheck, error) {
fkChecks := make([]*FKCheck, 0, len(tblInfo.ForeignKeys))
for _, fk := range tblInfo.ForeignKeys {
if fk.Version < 1 {
continue
}
if !isMapContainAnyCols(updateCols, fk.Cols...) {
continue
}
failedErr := ErrNoReferencedRow2.FastGenByArgs(fk.String(dbName, tblInfo.Name.L))
fkCheck, err := buildFKCheckOnModifyChildTable(ctx, is, fk, failedErr)
if err != nil {
return nil, err
}
if fkCheck != nil {
fkChecks = append(fkChecks, fkCheck)
}
}
return fkChecks, nil
}
func (updt *Update) buildTbl2UpdateColumns() map[int64]map[string]struct{} {
colsInfo := GetUpdateColumnsInfo(updt.tblID2Table, updt.TblColPosInfos, len(updt.SelectPlan.Schema().Columns))
tblID2UpdateColumns := make(map[int64]map[string]struct{})
for _, assign := range updt.OrderedList {
col := colsInfo[assign.Col.Index]
for _, content := range updt.TblColPosInfos {
if assign.Col.Index >= content.Start && assign.Col.Index < content.End {
if _, ok := tblID2UpdateColumns[content.TblID]; !ok {
tblID2UpdateColumns[content.TblID] = make(map[string]struct{})
}
tblID2UpdateColumns[content.TblID][col.Name.L] = struct{}{}
break
}
}
}
for tid, tbl := range updt.tblID2Table {
updateCols := tblID2UpdateColumns[tid]
if len(updateCols) == 0 {
continue
}
for _, col := range tbl.WritableCols() {
if !col.IsGenerated() || !col.GeneratedStored {
continue
}
for depCol := range col.Dependences {
if _, ok := updateCols[depCol]; ok {
tblID2UpdateColumns[tid][col.Name.L] = struct{}{}
}
}
}
}
return tblID2UpdateColumns
}
func buildOnDeleteOrUpdateFKTrigger(ctx sessionctx.Context, is infoschema.InfoSchema, referredFK *model.ReferredFKInfo, tp FKCascadeType) (*FKCheck, *FKCascade, error) {
childTable, err := is.TableByName(referredFK.ChildSchema, referredFK.ChildTable)
if err != nil {
return nil, nil, nil
}
fk := model.FindFKInfoByName(childTable.Meta().ForeignKeys, referredFK.ChildFKName.L)
if fk == nil || fk.Version < 1 {
return nil, nil, nil
}
var fkReferOption model.ReferOptionType
if fk.State != model.StatePublic {
fkReferOption = model.ReferOptionRestrict
} else {
switch tp {
case FKCascadeOnDelete:
fkReferOption = model.ReferOptionType(fk.OnDelete)
case FKCascadeOnUpdate:
fkReferOption = model.ReferOptionType(fk.OnUpdate)
}
}
switch fkReferOption {
case model.ReferOptionCascade, model.ReferOptionSetNull:
fkCascade, err := buildFKCascade(ctx, tp, referredFK, childTable, fk)
return nil, fkCascade, err
default:
fkCheck, err := buildFKCheckForReferredFK(ctx, childTable, fk, referredFK)
return fkCheck, nil, err
}
}
func isMapContainAnyCols(colsMap map[string]struct{}, cols ...model.CIStr) bool {
for _, col := range cols {
_, exist := colsMap[col.L]
if exist {
return true
}
}
return false
}
func buildFKCheckOnModifyChildTable(ctx sessionctx.Context, is infoschema.InfoSchema, fk *model.FKInfo, failedErr error) (*FKCheck, error) {
referTable, err := is.TableByName(fk.RefSchema, fk.RefTable)
if err != nil {
return nil, nil
}
fkCheck, err := buildFKCheck(ctx, referTable, fk.RefCols, failedErr)
if err != nil {
return nil, err
}
fkCheck.CheckExist = true
fkCheck.FK = fk
return fkCheck, nil
}
func buildFKCheckForReferredFK(ctx sessionctx.Context, childTable table.Table, fk *model.FKInfo, referredFK *model.ReferredFKInfo) (*FKCheck, error) {
failedErr := ErrRowIsReferenced2.GenWithStackByArgs(fk.String(referredFK.ChildSchema.L, referredFK.ChildTable.L))
fkCheck, err := buildFKCheck(ctx, childTable, fk.Cols, failedErr)
if err != nil {
return nil, err
}
fkCheck.CheckExist = false
fkCheck.ReferredFK = referredFK
return fkCheck, nil
}
func buildFKCheck(ctx sessionctx.Context, tbl table.Table, cols []model.CIStr, failedErr error) (*FKCheck, error) {
tblInfo := tbl.Meta()
if tblInfo.PKIsHandle && len(cols) == 1 {
refColInfo := model.FindColumnInfo(tblInfo.Columns, cols[0].L)
if refColInfo != nil && mysql.HasPriKeyFlag(refColInfo.GetFlag()) {
return FKCheck{
Tbl: tbl,
IdxIsPrimaryKey: true,
IdxIsExclusive: true,
FailedErr: failedErr,
}.Init(ctx), nil
}
}
referTbIdxInfo := model.FindIndexByColumns(tblInfo, cols...)
if referTbIdxInfo == nil {
return nil, failedErr
}
var tblIdx table.Index
for _, idx := range tbl.Indices() {
if idx.Meta().ID == referTbIdxInfo.ID {
tblIdx = idx
}
}
if tblIdx == nil {
return nil, failedErr
}
return FKCheck{
Tbl: tbl,
Idx: tblIdx,
IdxIsExclusive: len(cols) == len(referTbIdxInfo.Columns),
IdxIsPrimaryKey: referTbIdxInfo.Primary && tblInfo.IsCommonHandle,
FailedErr: failedErr,
}.Init(ctx), nil
}
func buildFKCascade(ctx sessionctx.Context, tp FKCascadeType, referredFK *model.ReferredFKInfo, childTable table.Table, fk *model.FKInfo) (*FKCascade, error) {
cols := make([]*model.ColumnInfo, len(fk.Cols))
childTableColumns := childTable.Meta().Columns
for i, c := range fk.Cols {
col := model.FindColumnInfo(childTableColumns, c.L)
if col == nil {
return nil, errors.Errorf("foreign key column %s is not found in table %s", c.L, childTable.Meta().Name)
}
cols[i] = col
}
fkCascade := FKCascade{
Tp: tp,
ReferredFK: referredFK,
ChildTable: childTable,
FK: fk,
FKCols: cols,
}.Init(ctx)
if childTable.Meta().PKIsHandle && len(cols) == 1 {
refColInfo := model.FindColumnInfo(childTableColumns, cols[0].Name.L)
if refColInfo != nil && mysql.HasPriKeyFlag(refColInfo.GetFlag()) {
return fkCascade, nil
}
}
indexForFK := model.FindIndexByColumns(childTable.Meta(), fk.Cols...)
if indexForFK == nil {
return nil, errors.Errorf("Missing index for '%s' foreign key columns in the table '%s'", fk.Name, childTable.Meta().Name)
}
fkCascade.FKIdx = indexForFK
return fkCascade, nil
}