-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
set.go
617 lines (543 loc) · 18.6 KB
/
set.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
/*
Copyright 2020 The Vitess Authors.
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 engine
import (
"bytes"
"context"
"encoding/json"
"fmt"
"strings"
"vitess.io/vitess/go/vt/sysvars"
vtgatepb "vitess.io/vitess/go/vt/proto/vtgate"
"vitess.io/vitess/go/vt/log"
"vitess.io/vitess/go/vt/srvtopo"
"vitess.io/vitess/go/vt/vtgate/evalengine"
"vitess.io/vitess/go/sqltypes"
"vitess.io/vitess/go/vt/key"
querypb "vitess.io/vitess/go/vt/proto/query"
vtrpcpb "vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/schema"
"vitess.io/vitess/go/vt/vterrors"
"vitess.io/vitess/go/vt/vtgate/vindexes"
)
type (
// Set contains the instructions to perform set.
Set struct {
Ops []SetOp
Input Primitive
noTxNeeded
}
// SetOp is an interface that different type of set operations implements.
SetOp interface {
Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error
VariableName() string
}
// UserDefinedVariable implements the SetOp interface to execute user defined variables.
UserDefinedVariable struct {
Name string
Expr evalengine.Expr
}
// SysVarIgnore implements the SetOp interface to ignore the settings.
SysVarIgnore struct {
Name string
Expr string
}
// SysVarCheckAndIgnore implements the SetOp interface to check underlying setting and ignore if same.
SysVarCheckAndIgnore struct {
Name string
Keyspace *vindexes.Keyspace
TargetDestination key.Destination `json:",omitempty"`
Expr string
}
// SysVarReservedConn implements the SetOp interface and will write the changes variable into the session
SysVarReservedConn struct {
Name string
Keyspace *vindexes.Keyspace
TargetDestination key.Destination `json:",omitempty"`
Expr string
SupportSetVar bool
}
// SysVarSetAware implements the SetOp interface and will write the changes variable into the session
// The special part is that these settings change the sessions behaviour in different ways
SysVarSetAware struct {
Name string
Expr evalengine.Expr
}
// VitessMetadata implements the SetOp interface and will write the changes variable into the topo server
VitessMetadata struct {
Name, Value string
}
)
var unsupportedSQLModes = []string{"ANSI_QUOTES", "NO_BACKSLASH_ESCAPES", "PIPES_AS_CONCAT", "REAL_AS_FLOAT"}
var _ Primitive = (*Set)(nil)
// RouteType implements the Primitive interface method.
func (s *Set) RouteType() string {
return "Set"
}
// GetKeyspaceName implements the Primitive interface method.
func (s *Set) GetKeyspaceName() string {
return ""
}
// GetTableName implements the Primitive interface method.
func (s *Set) GetTableName() string {
return ""
}
// TryExecute implements the Primitive interface method.
func (s *Set) TryExecute(ctx context.Context, vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool) (*sqltypes.Result, error) {
input, err := vcursor.ExecutePrimitive(ctx, s.Input, bindVars, false)
if err != nil {
return nil, err
}
if len(input.Rows) != 1 {
return nil, vterrors.Errorf(vtrpcpb.Code_FAILED_PRECONDITION, "should get a single row")
}
env := evalengine.NewExpressionEnv(ctx, bindVars, vcursor)
env.Row = input.Rows[0]
for _, setOp := range s.Ops {
err := setOp.Execute(ctx, vcursor, env)
if err != nil {
return nil, err
}
}
return &sqltypes.Result{}, nil
}
// TryStreamExecute implements the Primitive interface method.
func (s *Set) TryStreamExecute(ctx context.Context, vcursor VCursor, bindVars map[string]*querypb.BindVariable, wantfields bool, callback func(*sqltypes.Result) error) error {
result, err := s.TryExecute(ctx, vcursor, bindVars, wantfields)
if err != nil {
return err
}
return callback(result)
}
// GetFields implements the Primitive interface method.
func (s *Set) GetFields(context.Context, VCursor, map[string]*querypb.BindVariable) (*sqltypes.Result, error) {
return &sqltypes.Result{}, nil
}
// Inputs implements the Primitive interface
func (s *Set) Inputs() []Primitive {
return []Primitive{s.Input}
}
func (s *Set) description() PrimitiveDescription {
other := map[string]any{
"Ops": s.Ops,
}
return PrimitiveDescription{
OperatorType: "Set",
Other: other,
}
}
var _ SetOp = (*UserDefinedVariable)(nil)
// MarshalJSON provides the type to SetOp for plan json
func (u *UserDefinedVariable) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string
Name string
Expr string
}{
Type: "UserDefinedVariable",
Name: u.Name,
Expr: evalengine.FormatExpr(u.Expr),
})
}
// VariableName implements the SetOp interface method.
func (u *UserDefinedVariable) VariableName() string {
return u.Name
}
// Execute implements the SetOp interface method.
func (u *UserDefinedVariable) Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error {
value, err := env.Evaluate(u.Expr)
if err != nil {
return err
}
return vcursor.Session().SetUDV(u.Name, value.Value(vcursor.ConnCollation()))
}
var _ SetOp = (*SysVarIgnore)(nil)
// MarshalJSON provides the type to SetOp for plan json
func (svi *SysVarIgnore) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string
SysVarIgnore
}{
Type: "SysVarIgnore",
SysVarIgnore: *svi,
})
}
// VariableName implements the SetOp interface method.
func (svi *SysVarIgnore) VariableName() string {
return svi.Name
}
// Execute implements the SetOp interface method.
func (svi *SysVarIgnore) Execute(context.Context, VCursor, *evalengine.ExpressionEnv) error {
log.Infof("Ignored inapplicable SET %v = %v", svi.Name, svi.Expr)
return nil
}
var _ SetOp = (*SysVarCheckAndIgnore)(nil)
// MarshalJSON provides the type to SetOp for plan json
func (svci *SysVarCheckAndIgnore) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string
SysVarCheckAndIgnore
}{
Type: "SysVarCheckAndIgnore",
SysVarCheckAndIgnore: *svci,
})
}
// VariableName implements the SetOp interface method
func (svci *SysVarCheckAndIgnore) VariableName() string {
return svci.Name
}
// Execute implements the SetOp interface method
func (svci *SysVarCheckAndIgnore) Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error {
rss, _, err := vcursor.ResolveDestinations(ctx, svci.Keyspace.Name, nil, []key.Destination{svci.TargetDestination})
if err != nil {
return err
}
if len(rss) != 1 {
return vterrors.Errorf(vtrpcpb.Code_INVALID_ARGUMENT, "Unexpected error, DestinationKeyspaceID mapping to multiple shards: %v", svci.TargetDestination)
}
checkSysVarQuery := fmt.Sprintf("select 1 from dual where @@%s = %s", svci.Name, svci.Expr)
result, err := execShard(ctx, nil, vcursor, checkSysVarQuery, env.BindVars, rss[0], false /* rollbackOnError */, false /* canAutocommit */)
if err != nil {
// Rather than returning the error, we will just log the error
// as the intention for executing the query it to validate the current setting and eventually ignore it anyways.
// There is no benefit of returning the error back to client.
log.Warningf("unable to validate the current settings for '%s': %s", svci.Name, err.Error())
return nil
}
if len(result.Rows) == 0 {
log.Infof("Ignored inapplicable SET %v = %v", svci.Name, svci.Expr)
}
return nil
}
var _ SetOp = (*SysVarReservedConn)(nil)
// MarshalJSON provides the type to SetOp for plan json
func (svs *SysVarReservedConn) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string
SysVarReservedConn
}{
Type: "SysVarSet",
SysVarReservedConn: *svs,
})
}
// VariableName implements the SetOp interface method
func (svs *SysVarReservedConn) VariableName() string {
return svs.Name
}
// Execute implements the SetOp interface method
func (svs *SysVarReservedConn) Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error {
// For those running on advanced vitess settings.
if svs.TargetDestination != nil {
rss, _, err := vcursor.ResolveDestinations(ctx, svs.Keyspace.Name, nil, []key.Destination{svs.TargetDestination})
if err != nil {
return err
}
vcursor.Session().NeedsReservedConn()
return svs.execSetStatement(ctx, vcursor, rss, env)
}
needReservedConn, err := svs.checkAndUpdateSysVar(ctx, vcursor, env)
if err != nil {
return err
}
if !needReservedConn {
// setting ignored, same as underlying datastore
return nil
}
// Update existing shard session with new system variable settings.
rss := vcursor.Session().ShardSession()
if len(rss) == 0 {
return nil
}
queries := make([]*querypb.BoundQuery, len(rss))
for i := 0; i < len(rss); i++ {
queries[i] = &querypb.BoundQuery{
Sql: fmt.Sprintf("set %s = %s", svs.Name, svs.Expr),
BindVariables: env.BindVars,
}
}
_, errs := vcursor.ExecuteMultiShard(ctx, nil, rss, queries, false /* rollbackOnError */, false /* canAutocommit */)
return vterrors.Aggregate(errs)
}
func (svs *SysVarReservedConn) execSetStatement(ctx context.Context, vcursor VCursor, rss []*srvtopo.ResolvedShard, env *evalengine.ExpressionEnv) error {
queries := make([]*querypb.BoundQuery, len(rss))
for i := 0; i < len(rss); i++ {
queries[i] = &querypb.BoundQuery{
Sql: fmt.Sprintf("set @@%s = %s", svs.Name, svs.Expr),
BindVariables: env.BindVars,
}
}
_, errs := vcursor.ExecuteMultiShard(ctx, nil, rss, queries, false /* rollbackOnError */, false /* canAutocommit */)
return vterrors.Aggregate(errs)
}
func (svs *SysVarReservedConn) checkAndUpdateSysVar(ctx context.Context, vcursor VCursor, res *evalengine.ExpressionEnv) (bool, error) {
sysVarExprValidationQuery := fmt.Sprintf("select %s from dual where @@%s != %s", svs.Expr, svs.Name, svs.Expr)
if svs.Name == "sql_mode" {
sysVarExprValidationQuery = fmt.Sprintf("select @@%s orig, %s new", svs.Name, svs.Expr)
}
rss, _, err := vcursor.ResolveDestinations(ctx, svs.Keyspace.Name, nil, []key.Destination{key.DestinationKeyspaceID{0}})
if err != nil {
return false, err
}
qr, err := execShard(ctx, nil, vcursor, sysVarExprValidationQuery, res.BindVars, rss[0], false /* rollbackOnError */, false /* canAutocommit */)
if err != nil {
return false, err
}
changed := len(qr.Rows) > 0
if !changed {
return false, nil
}
var value sqltypes.Value
if svs.Name == "sql_mode" {
changed, value, err = sqlModeChangedValue(qr)
if err != nil {
return false, err
}
if !changed {
return false, nil
}
} else {
value = qr.Rows[0][0]
}
buf := new(bytes.Buffer)
value.EncodeSQL(buf)
s := buf.String()
vcursor.Session().SetSysVar(svs.Name, s)
// If the condition below is true, we want to use reserved connection instead of SET_VAR query hint.
// MySQL supports SET_VAR only in MySQL80 and for a limited set of system variables.
if !svs.SupportSetVar || s == "''" || !vcursor.CanUseSetVar() {
vcursor.Session().NeedsReservedConn()
return true, nil
}
return false, nil
}
func sqlModeChangedValue(qr *sqltypes.Result) (bool, sqltypes.Value, error) {
if len(qr.Fields) != 2 {
return false, sqltypes.Value{}, nil
}
if len(qr.Rows[0]) != 2 {
return false, sqltypes.Value{}, nil
}
orig := qr.Rows[0][0].ToString()
newVal := qr.Rows[0][1].ToString()
origArr := strings.Split(orig, ",")
// Keep track of if the value is seen or not.
origMap := map[string]bool{}
for _, oVal := range origArr {
// Default is not seen.
origMap[strings.ToUpper(oVal)] = true
}
uniqOrigVal := len(origMap)
origValSeen := 0
changed := false
newValArr := strings.Split(newVal, ",")
unsupportedMode := ""
for _, nVal := range newValArr {
nVal = strings.ToUpper(nVal)
for _, mode := range unsupportedSQLModes {
if mode == nVal {
unsupportedMode = nVal
break
}
}
notSeen, exists := origMap[nVal]
if !exists {
changed = true
break
}
if exists && notSeen {
// Value seen. Turn it off
origMap[nVal] = false
origValSeen++
}
}
if !changed && uniqOrigVal != origValSeen {
changed = true
}
if changed && unsupportedMode != "" {
return false, sqltypes.Value{}, vterrors.Errorf(vtrpcpb.Code_UNIMPLEMENTED, "setting the %s sql_mode is unsupported", unsupportedMode)
}
return changed, qr.Rows[0][1], nil
}
var _ SetOp = (*SysVarSetAware)(nil)
// MarshalJSON marshals all the json
func (svss *SysVarSetAware) MarshalJSON() ([]byte, error) {
return json.Marshal(struct {
Type string
Name string
Expr string
}{
Type: "SysVarAware",
Name: svss.Name,
Expr: evalengine.FormatExpr(svss.Expr),
})
}
// Execute implements the SetOp interface method
func (svss *SysVarSetAware) Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error {
var err error
switch svss.Name {
case sysvars.Autocommit.Name:
err = svss.setBoolSysVar(ctx, env, vcursor.Session().SetAutocommit)
case sysvars.ClientFoundRows.Name:
err = svss.setBoolSysVar(ctx, env, vcursor.Session().SetClientFoundRows)
case sysvars.SkipQueryPlanCache.Name:
err = svss.setBoolSysVar(ctx, env, vcursor.Session().SetSkipQueryPlanCache)
case sysvars.TxReadOnly.Name,
sysvars.TransactionReadOnly.Name:
// TODO (4127): This is a dangerous NOP.
noop := func(context.Context, bool) error { return nil }
err = svss.setBoolSysVar(ctx, env, noop)
case sysvars.SQLSelectLimit.Name:
intValue, err := svss.evalAsInt64(env, vcursor)
if err != nil {
return err
}
vcursor.Session().SetSQLSelectLimit(intValue) // nolint:errcheck
case sysvars.TransactionMode.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
out, ok := vtgatepb.TransactionMode_value[strings.ToUpper(str)]
if !ok {
return vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongValueForVar, "invalid transaction_mode: %s", str)
}
vcursor.Session().SetTransactionMode(vtgatepb.TransactionMode(out))
case sysvars.Workload.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
out, ok := querypb.ExecuteOptions_Workload_value[strings.ToUpper(str)]
if !ok {
return vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongValueForVar, "invalid workload: %s", str)
}
vcursor.Session().SetWorkload(querypb.ExecuteOptions_Workload(out))
case sysvars.DDLStrategy.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
if _, err := schema.ParseDDLStrategy(str); err != nil {
return vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongValueForVar, "invalid DDL strategy: %s", str)
}
vcursor.Session().SetDDLStrategy(str)
case sysvars.QueryTimeout.Name:
queryTimeout, err := svss.evalAsInt64(env, vcursor)
if err != nil {
return err
}
vcursor.Session().SetQueryTimeout(queryTimeout)
case sysvars.SessionEnableSystemSettings.Name:
err = svss.setBoolSysVar(ctx, env, vcursor.Session().SetSessionEnableSystemSettings)
case sysvars.Charset.Name, sysvars.Names.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
switch strings.ToLower(str) {
case "", "utf8", "utf8mb4", "latin1", "default":
// do nothing
break
default:
return vterrors.Errorf(vtrpcpb.Code_UNIMPLEMENTED, "charset/name %v is not supported", str)
}
case sysvars.ReadAfterWriteGTID.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
vcursor.Session().SetReadAfterWriteGTID(str)
case sysvars.ReadAfterWriteTimeOut.Name:
val, err := svss.evalAsFloat(env, vcursor)
if err != nil {
return err
}
vcursor.Session().SetReadAfterWriteTimeout(val)
case sysvars.SessionTrackGTIDs.Name:
str, err := svss.evalAsString(env, vcursor)
if err != nil {
return err
}
switch strings.ToLower(str) {
case "off":
vcursor.Session().SetSessionTrackGTIDs(false)
case "own_gtid":
vcursor.Session().SetSessionTrackGTIDs(true)
default:
return vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongValueForVar, "variable 'session_track_gtids' can't be set to the value of '%s'", str)
}
default:
return vterrors.NewErrorf(vtrpcpb.Code_NOT_FOUND, vterrors.UnknownSystemVariable, "unknown system variable '%s'", svss.Name)
}
return err
}
func (svss *SysVarSetAware) evalAsInt64(env *evalengine.ExpressionEnv, vcursor VCursor) (int64, error) {
value, err := env.Evaluate(svss.Expr)
if err != nil {
return 0, err
}
v := value.Value(vcursor.ConnCollation())
if !v.IsIntegral() {
return 0, vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongTypeForVar, "incorrect argument type to variable '%s': %s", svss.Name, v.Type().String())
}
intValue, err := v.ToInt64()
if err != nil {
return 0, err
}
return intValue, nil
}
func (svss *SysVarSetAware) evalAsFloat(env *evalengine.ExpressionEnv, vcursor VCursor) (float64, error) {
value, err := env.Evaluate(svss.Expr)
if err != nil {
return 0, err
}
v := value.Value(vcursor.ConnCollation())
floatValue, err := v.ToFloat64()
if err != nil {
return 0, vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongTypeForVar, "incorrect argument type to variable '%s': %s", svss.Name, v.Type().String())
}
return floatValue, nil
}
func (svss *SysVarSetAware) evalAsString(env *evalengine.ExpressionEnv, vcursor VCursor) (string, error) {
value, err := env.Evaluate(svss.Expr)
if err != nil {
return "", err
}
v := value.Value(vcursor.ConnCollation())
if !v.IsText() && !v.IsBinary() {
return "", vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongTypeForVar, "incorrect argument type to variable '%s': %s", svss.Name, v.Type().String())
}
return v.ToString(), nil
}
func (svss *SysVarSetAware) setBoolSysVar(ctx context.Context, env *evalengine.ExpressionEnv, setter func(context.Context, bool) error) error {
value, err := env.Evaluate(svss.Expr)
if err != nil {
return err
}
boolValue, err := value.ToBooleanStrict()
if err != nil {
return vterrors.NewErrorf(vtrpcpb.Code_INVALID_ARGUMENT, vterrors.WrongValueForVar, "variable '%s' can't be set to the value: %s", svss.Name, err.Error())
}
return setter(ctx, boolValue)
}
// VariableName implements the SetOp interface method
func (svss *SysVarSetAware) VariableName() string {
return svss.Name
}
var _ SetOp = (*VitessMetadata)(nil)
func (v *VitessMetadata) Execute(ctx context.Context, vcursor VCursor, env *evalengine.ExpressionEnv) error {
return vcursor.SetExec(ctx, v.Name, v.Value)
}
func (v *VitessMetadata) VariableName() string {
return v.Name
}