-
Notifications
You must be signed in to change notification settings - Fork 2.1k
/
executor.go
1535 lines (1340 loc) · 48.9 KB
/
executor.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 2019 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 vtgate
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"net/http"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/spf13/pflag"
"vitess.io/vitess/go/cache/theine"
"vitess.io/vitess/go/streamlog"
"vitess.io/vitess/go/vt/vthash"
"vitess.io/vitess/go/acl"
"vitess.io/vitess/go/mysql/collations"
"vitess.io/vitess/go/sqltypes"
"vitess.io/vitess/go/stats"
"vitess.io/vitess/go/trace"
"vitess.io/vitess/go/vt/callerid"
"vitess.io/vitess/go/vt/key"
"vitess.io/vitess/go/vt/log"
binlogdatapb "vitess.io/vitess/go/vt/proto/binlogdata"
querypb "vitess.io/vitess/go/vt/proto/query"
topodatapb "vitess.io/vitess/go/vt/proto/topodata"
vtgatepb "vitess.io/vitess/go/vt/proto/vtgate"
vtrpcpb "vitess.io/vitess/go/vt/proto/vtrpc"
"vitess.io/vitess/go/vt/servenv"
"vitess.io/vitess/go/vt/sqlparser"
"vitess.io/vitess/go/vt/srvtopo"
"vitess.io/vitess/go/vt/sysvars"
"vitess.io/vitess/go/vt/topo/topoproto"
"vitess.io/vitess/go/vt/vterrors"
"vitess.io/vitess/go/vt/vtgate/engine"
"vitess.io/vitess/go/vt/vtgate/evalengine"
"vitess.io/vitess/go/vt/vtgate/logstats"
"vitess.io/vitess/go/vt/vtgate/planbuilder"
"vitess.io/vitess/go/vt/vtgate/planbuilder/plancontext"
"vitess.io/vitess/go/vt/vtgate/vindexes"
"vitess.io/vitess/go/vt/vtgate/vschemaacl"
"vitess.io/vitess/go/vt/vtgate/vtgateservice"
)
var (
errNoKeyspace = vterrors.VT09005()
defaultTabletType = topodatapb.TabletType_PRIMARY
// TODO: @rafael - These two counters should be deprecated in favor of the ByTable ones in v17+. They are kept for now for backwards compatibility.
queriesProcessed = stats.NewCountersWithSingleLabel("QueriesProcessed", "Queries processed at vtgate by plan type", "Plan")
queriesRouted = stats.NewCountersWithSingleLabel("QueriesRouted", "Queries routed from vtgate to vttablet by plan type", "Plan")
queriesProcessedByTable = stats.NewCountersWithMultiLabels("QueriesProcessedByTable", "Queries processed at vtgate by plan type, keyspace and table", []string{"Plan", "Keyspace", "Table"})
queriesRoutedByTable = stats.NewCountersWithMultiLabels("QueriesRoutedByTable", "Queries routed from vtgate to vttablet by plan type, keyspace and table", []string{"Plan", "Keyspace", "Table"})
)
const (
bindVarPrefix = "__vt"
)
func init() {
registerTabletTypeFlag := func(fs *pflag.FlagSet) {
fs.Var((*topoproto.TabletTypeFlag)(&defaultTabletType), "default_tablet_type", "The default tablet type to set for queries, when one is not explicitly selected.")
}
servenv.OnParseFor("vtgate", registerTabletTypeFlag)
servenv.OnParseFor("vtgateclienttest", registerTabletTypeFlag)
servenv.OnParseFor("vtcombo", registerTabletTypeFlag)
servenv.OnParseFor("vtexplain", registerTabletTypeFlag)
}
// Executor is the engine that executes queries by utilizing
// the abilities of the underlying vttablets.
type Executor struct {
serv srvtopo.Server
cell string
resolver *Resolver
scatterConn *ScatterConn
txConn *TxConn
pv plancontext.PlannerVersion
mu sync.Mutex
vschema *vindexes.VSchema
streamSize int
vschemaStats *VSchemaStats
plans *PlanCache
epoch atomic.Uint32
normalize bool
warnShardedOnly bool
vm *VSchemaManager
schemaTracker SchemaInfo
// allowScatter will fail planning if set to false and a plan contains any scatter queries
allowScatter bool
// queryLogger is passed in for logging from this vtgate executor.
queryLogger *streamlog.StreamLogger[*logstats.LogStats]
}
var executorOnce sync.Once
const pathQueryPlans = "/debug/query_plans"
const pathScatterStats = "/debug/scatter_stats"
const pathVSchema = "/debug/vschema"
type PlanCacheKey = theine.HashKey256
type PlanCache = theine.Store[PlanCacheKey, *engine.Plan]
func DefaultPlanCache() *PlanCache {
// when being endtoend tested, disable the doorkeeper to ensure reproducible results
doorkeeper := !servenv.TestingEndtoend
return theine.NewStore[PlanCacheKey, *engine.Plan](queryPlanCacheMemory, doorkeeper)
}
// NewExecutor creates a new Executor.
func NewExecutor(
ctx context.Context,
serv srvtopo.Server,
cell string,
resolver *Resolver,
normalize, warnOnShardedOnly bool,
streamSize int,
plans *PlanCache,
schemaTracker SchemaInfo,
noScatter bool,
pv plancontext.PlannerVersion,
) *Executor {
e := &Executor{
serv: serv,
cell: cell,
resolver: resolver,
scatterConn: resolver.scatterConn,
txConn: resolver.scatterConn.txConn,
normalize: normalize,
warnShardedOnly: warnOnShardedOnly,
streamSize: streamSize,
schemaTracker: schemaTracker,
allowScatter: !noScatter,
pv: pv,
plans: plans,
}
vschemaacl.Init()
// we subscribe to update from the VSchemaManager
e.vm = &VSchemaManager{
subscriber: e.SaveVSchema,
serv: serv,
cell: cell,
schema: e.schemaTracker,
}
serv.WatchSrvVSchema(ctx, cell, e.vm.VSchemaUpdate)
executorOnce.Do(func() {
stats.NewGaugeFunc("QueryPlanCacheLength", "Query plan cache length", func() int64 {
return int64(e.plans.Len())
})
stats.NewGaugeFunc("QueryPlanCacheSize", "Query plan cache size", func() int64 {
return int64(e.plans.UsedCapacity())
})
stats.NewGaugeFunc("QueryPlanCacheCapacity", "Query plan cache capacity", func() int64 {
return int64(e.plans.MaxCapacity())
})
stats.NewCounterFunc("QueryPlanCacheEvictions", "Query plan cache evictions", func() int64 {
return e.plans.Metrics.Evicted()
})
stats.NewCounterFunc("QueryPlanCacheHits", "Query plan cache hits", func() int64 {
return e.plans.Metrics.Hits()
})
stats.NewCounterFunc("QueryPlanCacheMisses", "Query plan cache misses", func() int64 {
return e.plans.Metrics.Hits()
})
servenv.HTTPHandle(pathQueryPlans, e)
servenv.HTTPHandle(pathScatterStats, e)
servenv.HTTPHandle(pathVSchema, e)
})
return e
}
// Execute executes a non-streaming query.
func (e *Executor) Execute(ctx context.Context, mysqlCtx vtgateservice.MySQLConnection, method string, safeSession *SafeSession, sql string, bindVars map[string]*querypb.BindVariable) (result *sqltypes.Result, err error) {
span, ctx := trace.NewSpan(ctx, "executor.Execute")
span.Annotate("method", method)
trace.AnnotateSQL(span, sqlparser.Preview(sql))
defer span.Finish()
logStats := logstats.NewLogStats(ctx, method, sql, safeSession.GetSessionUUID(), bindVars)
stmtType, result, err := e.execute(ctx, mysqlCtx, safeSession, sql, bindVars, logStats)
logStats.Error = err
if result == nil {
saveSessionStats(safeSession, stmtType, 0, 0, 0, err)
} else {
saveSessionStats(safeSession, stmtType, result.RowsAffected, result.InsertID, len(result.Rows), err)
}
if result != nil && len(result.Rows) > warnMemoryRows {
warnings.Add("ResultsExceeded", 1)
piiSafeSQL, err := sqlparser.RedactSQLQuery(sql)
if err != nil {
piiSafeSQL = logStats.StmtType
}
log.Warningf("%q exceeds warning threshold of max memory rows: %v. Actual memory rows: %v", piiSafeSQL, warnMemoryRows, len(result.Rows))
}
logStats.SaveEndTime()
e.queryLogger.Send(logStats)
err = vterrors.TruncateError(err, truncateErrorLen)
return result, err
}
type streaminResultReceiver struct {
mu sync.Mutex
stmtType sqlparser.StatementType
rowsAffected uint64
rowsReturned int
insertID uint64
callback func(*sqltypes.Result) error
}
func (s *streaminResultReceiver) storeResultStats(typ sqlparser.StatementType, qr *sqltypes.Result) error {
s.mu.Lock()
defer s.mu.Unlock()
s.rowsAffected += qr.RowsAffected
s.rowsReturned += len(qr.Rows)
if qr.InsertID != 0 {
s.insertID = qr.InsertID
}
s.stmtType = typ
return s.callback(qr)
}
// StreamExecute executes a streaming query.
func (e *Executor) StreamExecute(
ctx context.Context,
mysqlCtx vtgateservice.MySQLConnection,
method string,
safeSession *SafeSession,
sql string,
bindVars map[string]*querypb.BindVariable,
callback func(*sqltypes.Result) error,
) error {
span, ctx := trace.NewSpan(ctx, "executor.StreamExecute")
span.Annotate("method", method)
trace.AnnotateSQL(span, sqlparser.Preview(sql))
defer span.Finish()
logStats := logstats.NewLogStats(ctx, method, sql, safeSession.GetSessionUUID(), bindVars)
srr := &streaminResultReceiver{callback: callback}
var err error
resultHandler := func(ctx context.Context, plan *engine.Plan, vc *vcursorImpl, bindVars map[string]*querypb.BindVariable, execStart time.Time) error {
var seenResults atomic.Bool
var resultMu sync.Mutex
result := &sqltypes.Result{}
if canReturnRows(plan.Type) {
srr.callback = func(qr *sqltypes.Result) error {
resultMu.Lock()
defer resultMu.Unlock()
// If the row has field info, send it separately.
// TODO(sougou): this behavior is for handling tests because
// the framework currently sends all results as one packet.
byteCount := 0
if len(qr.Fields) > 0 {
if err := callback(qr.Metadata()); err != nil {
return err
}
seenResults.Store(true)
}
for _, row := range qr.Rows {
result.Rows = append(result.Rows, row)
for _, col := range row {
byteCount += col.Len()
}
if byteCount >= e.streamSize {
err := callback(result)
seenResults.Store(true)
result = &sqltypes.Result{}
byteCount = 0
if err != nil {
return err
}
}
}
return nil
}
}
// 4: Execute!
err := vc.StreamExecutePrimitive(ctx, plan.Instructions, bindVars, true, func(qr *sqltypes.Result) error {
return srr.storeResultStats(plan.Type, qr)
})
// Check if there was partial DML execution. If so, rollback the effect of the partially executed query.
if err != nil {
if !canReturnRows(plan.Type) {
return e.rollbackExecIfNeeded(ctx, safeSession, bindVars, logStats, err)
}
return err
}
if !canReturnRows(plan.Type) {
return nil
}
// Send left-over rows if there is no error on execution.
if len(result.Rows) > 0 || !seenResults.Load() {
if err := callback(result); err != nil {
return err
}
}
// 5: Log and add statistics
logStats.TablesUsed = plan.TablesUsed
logStats.TabletType = vc.TabletType().String()
logStats.ExecuteTime = time.Since(execStart)
logStats.ActiveKeyspace = vc.keyspace
e.updateQueryCounts(plan.Instructions.RouteType(), plan.Instructions.GetKeyspaceName(), plan.Instructions.GetTableName(), int64(logStats.ShardQueries))
return err
}
err = e.newExecute(ctx, mysqlCtx, safeSession, sql, bindVars, logStats, resultHandler, srr.storeResultStats)
logStats.Error = err
saveSessionStats(safeSession, srr.stmtType, srr.rowsAffected, srr.insertID, srr.rowsReturned, err)
if srr.rowsReturned > warnMemoryRows {
warnings.Add("ResultsExceeded", 1)
piiSafeSQL, err := sqlparser.RedactSQLQuery(sql)
if err != nil {
piiSafeSQL = logStats.StmtType
}
log.Warningf("%q exceeds warning threshold of max memory rows: %v. Actual memory rows: %v", piiSafeSQL, warnMemoryRows, srr.rowsReturned)
}
logStats.SaveEndTime()
e.queryLogger.Send(logStats)
return vterrors.TruncateError(err, truncateErrorLen)
}
func canReturnRows(stmtType sqlparser.StatementType) bool {
switch stmtType {
case sqlparser.StmtSelect, sqlparser.StmtShow, sqlparser.StmtExplain, sqlparser.StmtCallProc:
return true
default:
return false
}
}
func saveSessionStats(safeSession *SafeSession, stmtType sqlparser.StatementType, rowsAffected, insertID uint64, rowsReturned int, err error) {
safeSession.RowCount = -1
if err != nil {
return
}
if !safeSession.foundRowsHandled {
safeSession.FoundRows = uint64(rowsReturned)
}
if insertID > 0 {
safeSession.LastInsertId = insertID
}
switch stmtType {
case sqlparser.StmtInsert, sqlparser.StmtReplace, sqlparser.StmtUpdate, sqlparser.StmtDelete:
safeSession.RowCount = int64(rowsAffected)
case sqlparser.StmtDDL, sqlparser.StmtSet, sqlparser.StmtBegin, sqlparser.StmtCommit, sqlparser.StmtRollback, sqlparser.StmtFlush:
safeSession.RowCount = 0
}
}
func (e *Executor) execute(ctx context.Context, mysqlCtx vtgateservice.MySQLConnection, safeSession *SafeSession, sql string, bindVars map[string]*querypb.BindVariable, logStats *logstats.LogStats) (sqlparser.StatementType, *sqltypes.Result, error) {
var err error
var qr *sqltypes.Result
var stmtType sqlparser.StatementType
err = e.newExecute(ctx, mysqlCtx, safeSession, sql, bindVars, logStats, func(ctx context.Context, plan *engine.Plan, vc *vcursorImpl, bindVars map[string]*querypb.BindVariable, time time.Time) error {
stmtType = plan.Type
qr, err = e.executePlan(ctx, safeSession, plan, vc, bindVars, logStats, time)
return err
}, func(typ sqlparser.StatementType, result *sqltypes.Result) error {
stmtType = typ
qr = result
return nil
})
return stmtType, qr, err
}
// addNeededBindVars adds bind vars that are needed by the plan
func (e *Executor) addNeededBindVars(vcursor *vcursorImpl, bindVarNeeds *sqlparser.BindVarNeeds, bindVars map[string]*querypb.BindVariable, session *SafeSession) error {
for _, funcName := range bindVarNeeds.NeedFunctionResult {
switch funcName {
case sqlparser.DBVarName:
bindVars[sqlparser.DBVarName] = sqltypes.StringBindVariable(session.TargetString)
case sqlparser.LastInsertIDName:
bindVars[sqlparser.LastInsertIDName] = sqltypes.Uint64BindVariable(session.GetLastInsertId())
case sqlparser.FoundRowsName:
bindVars[sqlparser.FoundRowsName] = sqltypes.Int64BindVariable(int64(session.FoundRows))
case sqlparser.RowCountName:
bindVars[sqlparser.RowCountName] = sqltypes.Int64BindVariable(session.RowCount)
}
}
for _, sysVar := range bindVarNeeds.NeedSystemVariable {
key := bindVarPrefix + sysVar
switch sysVar {
case sysvars.Autocommit.Name:
bindVars[key] = sqltypes.BoolBindVariable(session.Autocommit)
case sysvars.QueryTimeout.Name:
bindVars[key] = sqltypes.Int64BindVariable(session.GetQueryTimeout())
case sysvars.ClientFoundRows.Name:
var v bool
ifOptionsExist(session, func(options *querypb.ExecuteOptions) {
v = options.ClientFoundRows
})
bindVars[key] = sqltypes.BoolBindVariable(v)
case sysvars.SkipQueryPlanCache.Name:
var v bool
ifOptionsExist(session, func(options *querypb.ExecuteOptions) {
v = options.ClientFoundRows
})
bindVars[key] = sqltypes.BoolBindVariable(v)
case sysvars.SQLSelectLimit.Name:
var v int64
ifOptionsExist(session, func(options *querypb.ExecuteOptions) {
v = options.SqlSelectLimit
})
bindVars[key] = sqltypes.Int64BindVariable(v)
case sysvars.TransactionMode.Name:
bindVars[key] = sqltypes.StringBindVariable(session.TransactionMode.String())
case sysvars.Workload.Name:
var v string
ifOptionsExist(session, func(options *querypb.ExecuteOptions) {
v = options.GetWorkload().String()
})
bindVars[key] = sqltypes.StringBindVariable(v)
case sysvars.DDLStrategy.Name:
bindVars[key] = sqltypes.StringBindVariable(session.DDLStrategy)
case sysvars.MigrationContext.Name:
bindVars[key] = sqltypes.StringBindVariable(session.MigrationContext)
case sysvars.SessionUUID.Name:
bindVars[key] = sqltypes.StringBindVariable(session.SessionUUID)
case sysvars.SessionEnableSystemSettings.Name:
bindVars[key] = sqltypes.BoolBindVariable(session.EnableSystemSettings)
case sysvars.ReadAfterWriteGTID.Name:
var v string
ifReadAfterWriteExist(session, func(raw *vtgatepb.ReadAfterWrite) {
v = raw.ReadAfterWriteGtid
})
bindVars[key] = sqltypes.StringBindVariable(v)
case sysvars.ReadAfterWriteTimeOut.Name:
var v float64
ifReadAfterWriteExist(session, func(raw *vtgatepb.ReadAfterWrite) {
v = raw.ReadAfterWriteTimeout
})
bindVars[key] = sqltypes.Float64BindVariable(v)
case sysvars.SessionTrackGTIDs.Name:
v := "off"
ifReadAfterWriteExist(session, func(raw *vtgatepb.ReadAfterWrite) {
if raw.SessionTrackGtids {
v = "own_gtid"
}
})
bindVars[key] = sqltypes.StringBindVariable(v)
case sysvars.Version.Name:
bindVars[key] = sqltypes.StringBindVariable(servenv.AppVersion.MySQLVersion())
case sysvars.VersionComment.Name:
bindVars[key] = sqltypes.StringBindVariable(servenv.AppVersion.String())
case sysvars.Socket.Name:
bindVars[key] = sqltypes.StringBindVariable(mysqlSocketPath())
default:
if value, hasSysVar := session.SystemVariables[sysVar]; hasSysVar {
expr, err := sqlparser.ParseExpr(value)
if err != nil {
return err
}
evalExpr, err := evalengine.Translate(expr, nil)
if err != nil {
return err
}
evaluated, err := evalengine.EmptyExpressionEnv().Evaluate(evalExpr)
if err != nil {
return err
}
bindVars[key] = sqltypes.ValueBindVariable(evaluated.Value(vcursor.collation))
}
}
}
udvMap := session.UserDefinedVariables
if udvMap == nil {
udvMap = map[string]*querypb.BindVariable{}
}
for _, udv := range bindVarNeeds.NeedUserDefinedVariables {
val := udvMap[udv]
if val == nil {
val = sqltypes.NullBindVariable
}
bindVars[sqlparser.UserDefinedVariableName+udv] = val
}
return nil
}
func ifOptionsExist(session *SafeSession, f func(*querypb.ExecuteOptions)) {
options := session.GetOptions()
if options != nil {
f(options)
}
}
func ifReadAfterWriteExist(session *SafeSession, f func(*vtgatepb.ReadAfterWrite)) {
raw := session.ReadAfterWrite
if raw != nil {
f(raw)
}
}
func (e *Executor) handleBegin(ctx context.Context, safeSession *SafeSession, logStats *logstats.LogStats, stmt sqlparser.Statement) (*sqltypes.Result, error) {
execStart := time.Now()
logStats.PlanTime = execStart.Sub(logStats.StartTime)
begin := stmt.(*sqlparser.Begin)
err := e.txConn.Begin(ctx, safeSession, begin.TxAccessModes)
logStats.ExecuteTime = time.Since(execStart)
e.updateQueryCounts("Begin", "", "", 0)
return &sqltypes.Result{}, err
}
func (e *Executor) handleCommit(ctx context.Context, safeSession *SafeSession, logStats *logstats.LogStats) (*sqltypes.Result, error) {
execStart := time.Now()
logStats.PlanTime = execStart.Sub(logStats.StartTime)
logStats.ShardQueries = uint64(len(safeSession.ShardSessions))
e.updateQueryCounts("Commit", "", "", int64(logStats.ShardQueries))
err := e.txConn.Commit(ctx, safeSession)
logStats.CommitTime = time.Since(execStart)
return &sqltypes.Result{}, err
}
// Commit commits the existing transactions
func (e *Executor) Commit(ctx context.Context, safeSession *SafeSession) error {
return e.txConn.Commit(ctx, safeSession)
}
func (e *Executor) handleRollback(ctx context.Context, safeSession *SafeSession, logStats *logstats.LogStats) (*sqltypes.Result, error) {
execStart := time.Now()
logStats.PlanTime = execStart.Sub(logStats.StartTime)
logStats.ShardQueries = uint64(len(safeSession.ShardSessions))
e.updateQueryCounts("Rollback", "", "", int64(logStats.ShardQueries))
err := e.txConn.Rollback(ctx, safeSession)
logStats.CommitTime = time.Since(execStart)
return &sqltypes.Result{}, err
}
func (e *Executor) handleSavepoint(ctx context.Context, safeSession *SafeSession, sql string, planType string, logStats *logstats.LogStats, nonTxResponse func(query string) (*sqltypes.Result, error), ignoreMaxMemoryRows bool) (*sqltypes.Result, error) {
execStart := time.Now()
logStats.PlanTime = execStart.Sub(logStats.StartTime)
logStats.ShardQueries = uint64(len(safeSession.ShardSessions))
e.updateQueryCounts(planType, "", "", int64(logStats.ShardQueries))
defer func() {
logStats.ExecuteTime = time.Since(execStart)
}()
// If no transaction exists on any of the shard sessions,
// then savepoint does not need to be executed, it will be only stored in the session
// and later will be executed when a transaction is started.
if !safeSession.isTxOpen() {
if safeSession.InTransaction() {
// Storing, as this needs to be executed just after starting transaction on the shard.
safeSession.StoreSavepoint(sql)
return &sqltypes.Result{}, nil
}
return nonTxResponse(sql)
}
orig := safeSession.commitOrder
qr, err := e.executeSPInAllSessions(ctx, safeSession, sql, ignoreMaxMemoryRows)
safeSession.SetCommitOrder(orig)
if err != nil {
return nil, err
}
safeSession.StoreSavepoint(sql)
return qr, nil
}
// executeSPInAllSessions function executes the savepoint query in all open shard sessions (pre, normal and post)
// which has non-zero transaction id (i.e. an open transaction on the shard connection).
func (e *Executor) executeSPInAllSessions(ctx context.Context, safeSession *SafeSession, sql string, ignoreMaxMemoryRows bool) (*sqltypes.Result, error) {
var qr *sqltypes.Result
var errs []error
for _, co := range []vtgatepb.CommitOrder{vtgatepb.CommitOrder_PRE, vtgatepb.CommitOrder_NORMAL, vtgatepb.CommitOrder_POST} {
safeSession.SetCommitOrder(co)
var rss []*srvtopo.ResolvedShard
var queries []*querypb.BoundQuery
for _, shardSession := range safeSession.getSessions() {
// This will avoid executing savepoint on reserved connections
// which has no open transaction.
if shardSession.TransactionId == 0 {
continue
}
rss = append(rss, &srvtopo.ResolvedShard{
Target: shardSession.Target,
Gateway: e.resolver.resolver.GetGateway(),
})
queries = append(queries, &querypb.BoundQuery{Sql: sql})
}
qr, errs = e.ExecuteMultiShard(ctx, nil, rss, queries, safeSession, false /*autocommit*/, ignoreMaxMemoryRows)
err := vterrors.Aggregate(errs)
if err != nil {
return nil, err
}
}
return qr, nil
}
// handleKill executed the kill statement.
func (e *Executor) handleKill(ctx context.Context, mysqlCtx vtgateservice.MySQLConnection, stmt sqlparser.Statement, logStats *logstats.LogStats) (result *sqltypes.Result, err error) {
execStart := time.Now()
logStats.PlanTime = execStart.Sub(logStats.StartTime)
e.updateQueryCounts("Kill", "", "", 0)
defer func() {
logStats.ExecuteTime = time.Since(execStart)
}()
if !allowKillStmt {
return nil, vterrors.VT07001("kill statement execution not permitted.")
}
if mysqlCtx == nil {
return nil, vterrors.VT12001("kill statement works with access through mysql protocol")
}
killStmt := stmt.(*sqlparser.Kill)
switch killStmt.Type {
case sqlparser.QueryType:
err = mysqlCtx.KillQuery(uint32(killStmt.ProcesslistID))
default:
err = mysqlCtx.KillConnection(ctx, uint32(killStmt.ProcesslistID))
}
if err != nil {
return nil, err
}
return &sqltypes.Result{}, nil
}
// CloseSession releases the current connection, which rollbacks open transactions and closes reserved connections.
// It is called then the MySQL servers closes the connection to its client.
func (e *Executor) CloseSession(ctx context.Context, safeSession *SafeSession) error {
return e.txConn.ReleaseAll(ctx, safeSession)
}
func (e *Executor) setVitessMetadata(ctx context.Context, name, value string) error {
// TODO(kalfonso): move to its own acl check and consolidate into an acl component that can handle multiple operations (vschema, metadata)
user := callerid.ImmediateCallerIDFromContext(ctx)
allowed := vschemaacl.Authorized(user)
if !allowed {
return vterrors.NewErrorf(vtrpcpb.Code_PERMISSION_DENIED, vterrors.AccessDeniedError, "User '%s' not authorized to perform vitess metadata operations", user.GetUsername())
}
ts, err := e.serv.GetTopoServer()
if err != nil {
return err
}
if value == "" {
return ts.DeleteMetadata(ctx, name)
}
return ts.UpsertMetadata(ctx, name, value)
}
func (e *Executor) showVitessMetadata(ctx context.Context, filter *sqlparser.ShowFilter) (*sqltypes.Result, error) {
ts, err := e.serv.GetTopoServer()
if err != nil {
return nil, err
}
var metadata map[string]string
if filter == nil {
metadata, err = ts.GetMetadata(ctx, "")
if err != nil {
return nil, err
}
} else {
metadata, err = ts.GetMetadata(ctx, filter.Like)
if err != nil {
return nil, err
}
}
rows := make([][]sqltypes.Value, 0, len(metadata))
for k, v := range metadata {
row := buildVarCharRow(k, v)
rows = append(rows, row)
}
return &sqltypes.Result{
Fields: buildVarCharFields("Key", "Value"),
Rows: rows,
}, nil
}
type tabletFilter func(tablet *topodatapb.Tablet, servingState string, primaryTermStartTime int64) bool
func (e *Executor) showShards(ctx context.Context, filter *sqlparser.ShowFilter, destTabletType topodatapb.TabletType) (*sqltypes.Result, error) {
showVitessShardsFilters := func(filter *sqlparser.ShowFilter) ([]func(string) bool, []func(string, *topodatapb.ShardReference) bool) {
keyspaceFilters := []func(string) bool{}
shardFilters := []func(string, *topodatapb.ShardReference) bool{}
if filter == nil {
return keyspaceFilters, shardFilters
}
if filter.Like != "" {
shardLikeRexep := sqlparser.LikeToRegexp(filter.Like)
if strings.Contains(filter.Like, "/") {
keyspaceLikeRexep := sqlparser.LikeToRegexp(strings.Split(filter.Like, "/")[0])
keyspaceFilters = append(keyspaceFilters, func(ks string) bool {
return keyspaceLikeRexep.MatchString(ks)
})
}
shardFilters = append(shardFilters, func(ks string, shard *topodatapb.ShardReference) bool {
return shardLikeRexep.MatchString(topoproto.KeyspaceShardString(ks, shard.Name))
})
return keyspaceFilters, shardFilters
}
if filter.Filter != nil {
// TODO build a query planner I guess? lol that should be fun
log.Infof("SHOW VITESS_SHARDS where clause %+v. Ignoring this (for now).", filter.Filter)
}
return keyspaceFilters, shardFilters
}
keyspaceFilters, shardFilters := showVitessShardsFilters(filter)
keyspaces, err := e.resolver.resolver.GetAllKeyspaces(ctx)
if err != nil {
return nil, err
}
var rows [][]sqltypes.Value
for _, keyspace := range keyspaces {
skipKeyspace := false
for _, filter := range keyspaceFilters {
if !filter(keyspace) {
skipKeyspace = true
break
}
}
if skipKeyspace {
continue
}
_, _, shards, err := e.resolver.resolver.GetKeyspaceShards(ctx, keyspace, destTabletType)
if err != nil {
// There might be a misconfigured keyspace or no shards in the keyspace.
// Skip any errors and move on.
continue
}
for _, shard := range shards {
skipShard := false
for _, filter := range shardFilters {
if !filter(keyspace, shard) {
skipShard = true
break
}
}
if skipShard {
continue
}
rows = append(rows, buildVarCharRow(topoproto.KeyspaceShardString(keyspace, shard.Name)))
}
}
return &sqltypes.Result{
Fields: buildVarCharFields("Shards"),
Rows: rows,
}, nil
}
func (e *Executor) showTablets(filter *sqlparser.ShowFilter) (*sqltypes.Result, error) {
getTabletFilters := func(filter *sqlparser.ShowFilter) []tabletFilter {
var filters []tabletFilter
if filter == nil {
return filters
}
if filter.Like != "" {
tabletRegexp := sqlparser.LikeToRegexp(filter.Like)
f := func(tablet *topodatapb.Tablet, servingState string, primaryTermStartTime int64) bool {
return tabletRegexp.MatchString(tablet.Hostname)
}
filters = append(filters, f)
return filters
}
if filter.Filter != nil {
log.Infof("SHOW VITESS_TABLETS where clause: %+v. Ignoring this (for now).", filter.Filter)
}
return filters
}
tabletFilters := getTabletFilters(filter)
rows := [][]sqltypes.Value{}
status := e.scatterConn.GetHealthCheckCacheStatus()
for _, s := range status {
for _, ts := range s.TabletsStats {
state := "SERVING"
if !ts.Serving {
state = "NOT_SERVING"
}
ptst := ts.PrimaryTermStartTime
ptstStr := ""
if ptst > 0 {
// this code depends on the fact that PrimaryTermStartTime is the seconds since epoch start
ptstStr = time.Unix(ptst, 0).UTC().Format(time.RFC3339)
}
skipTablet := false
for _, filter := range tabletFilters {
if !filter(ts.Tablet, state, ptst) {
skipTablet = true
break
}
}
if skipTablet {
continue
}
rows = append(rows, buildVarCharRow(
s.Cell,
s.Target.Keyspace,
s.Target.Shard,
ts.Target.TabletType.String(),
state,
topoproto.TabletAliasString(ts.Tablet.Alias),
ts.Tablet.Hostname,
ptstStr,
))
}
}
return &sqltypes.Result{
Fields: buildVarCharFields("Cell", "Keyspace", "Shard", "TabletType", "State", "Alias", "Hostname", "PrimaryTermStartTime"),
Rows: rows,
}, nil
}
func (e *Executor) showVitessReplicationStatus(ctx context.Context, filter *sqlparser.ShowFilter) (*sqltypes.Result, error) {
ctx, cancel := context.WithTimeout(ctx, healthCheckTimeout)
defer cancel()
rows := [][]sqltypes.Value{}
status := e.scatterConn.GetHealthCheckCacheStatus()
for _, s := range status {
for _, ts := range s.TabletsStats {
// We only want to show REPLICA and RDONLY tablets
if ts.Target.TabletType != topodatapb.TabletType_REPLICA && ts.Target.TabletType != topodatapb.TabletType_RDONLY {
continue
}
// Allow people to filter by Keyspace and Shard using a LIKE clause
if filter != nil {
ksFilterRegex := sqlparser.LikeToRegexp(filter.Like)
keyspaceShardStr := fmt.Sprintf("%s/%s", ts.Target.Keyspace, ts.Target.Shard)
if !ksFilterRegex.MatchString(keyspaceShardStr) {
continue
}
}
tabletHostPort := ts.GetTabletHostPort()
throttlerStatus, err := getTabletThrottlerStatus(tabletHostPort)
if err != nil {
log.Warningf("Could not get throttler status from %s: %v", tabletHostPort, err)
}
replSourceHost := ""
replSourcePort := int64(0)
replIOThreadHealth := ""
replSQLThreadHealth := ""
replLastError := ""
replLag := int64(-1)
sql := "show slave status"
results, err := e.txConn.tabletGateway.Execute(ctx, ts.Target, sql, nil, 0, 0, nil)
if err != nil || results == nil {
log.Warningf("Could not get replication status from %s: %v", tabletHostPort, err)
} else if row := results.Named().Row(); row != nil {
replSourceHost = row["Master_Host"].ToString()
replSourcePort, _ = row["Master_Port"].ToInt64()
replIOThreadHealth = row["Slave_IO_Running"].ToString()
replSQLThreadHealth = row["Slave_SQL_Running"].ToString()
replLastError = row["Last_Error"].ToString()
if ts.Stats != nil {
replLag = int64(ts.Stats.ReplicationLagSeconds)
}
}
replicationHealth := fmt.Sprintf("{\"EventStreamRunning\":\"%s\",\"EventApplierRunning\":\"%s\",\"LastError\":\"%s\"}", replIOThreadHealth, replSQLThreadHealth, replLastError)
rows = append(rows, buildVarCharRow(
s.Target.Keyspace,
s.Target.Shard,
ts.Target.TabletType.String(),
topoproto.TabletAliasString(ts.Tablet.Alias),
ts.Tablet.Hostname,
fmt.Sprintf("%s:%d", replSourceHost, replSourcePort),
replicationHealth,
fmt.Sprintf("%d", replLag),
throttlerStatus,
))
}
}
return &sqltypes.Result{
Fields: buildVarCharFields("Keyspace", "Shard", "TabletType", "Alias", "Hostname", "ReplicationSource", "ReplicationHealth", "ReplicationLag", "ThrottlerStatus"),
Rows: rows,
}, nil
}
// MessageStream is part of the vtgate service API. This is a V2 level API that's sent
// to the Resolver.
func (e *Executor) MessageStream(ctx context.Context, keyspace string, shard string, keyRange *topodatapb.KeyRange, name string, callback func(*sqltypes.Result) error) error {
err := e.resolver.MessageStream(
ctx,
keyspace,
shard,
keyRange,
name,
callback,
)
return formatError(err)
}
// VSchema returns the VSchema.
func (e *Executor) VSchema() *vindexes.VSchema {
e.mu.Lock()
defer e.mu.Unlock()
return e.vschema
}
// SaveVSchema updates the vschema and stats
func (e *Executor) SaveVSchema(vschema *vindexes.VSchema, stats *VSchemaStats) {
e.mu.Lock()
defer e.mu.Unlock()
if vschema != nil {
e.vschema = vschema
}
e.vschemaStats = stats
e.ClearPlans()
if vschemaCounters != nil {
vschemaCounters.Add("Reload", 1)
}
if vindexUnknownParams != nil {
var unknownParams int
for _, ks := range stats.Keyspaces {
unknownParams += ks.VindexUnknownParamsCount
}
vindexUnknownParams.Set(int64(unknownParams))
}
}