-
Notifications
You must be signed in to change notification settings - Fork 2k
/
explain.go
161 lines (138 loc) · 4.79 KB
/
explain.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
/*
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 planbuilder
import (
"strings"
"vitess.io/vitess/go/vt/vtgate/planbuilder/plancontext"
"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/sqlparser"
"vitess.io/vitess/go/vt/vterrors"
"vitess.io/vitess/go/vt/vtgate/engine"
)
// Builds an explain-plan for the given Primitive
func buildExplainPlan(stmt sqlparser.Explain, reservedVars *sqlparser.ReservedVars, vschema plancontext.VSchema, enableOnlineDDL, enableDirectDDL bool) (engine.Primitive, error) {
switch explain := stmt.(type) {
case *sqlparser.ExplainTab:
return explainTabPlan(explain, vschema)
case *sqlparser.ExplainStmt:
if explain.Type == sqlparser.VitessType {
return buildVitessTypePlan(explain, reservedVars, vschema, enableOnlineDDL, enableDirectDDL)
}
return buildOtherReadAndAdmin(sqlparser.String(explain), vschema)
}
return nil, vterrors.Errorf(vtrpcpb.Code_INTERNAL, "[BUG] unexpected explain type: %T", stmt)
}
func explainTabPlan(explain *sqlparser.ExplainTab, vschema plancontext.VSchema) (engine.Primitive, error) {
_, _, ks, _, destination, err := vschema.FindTableOrVindex(explain.Table)
if err != nil {
return nil, err
}
explain.Table.Qualifier = sqlparser.NewTableIdent("")
if destination == nil {
destination = key.DestinationAnyShard{}
}
keyspace, err := vschema.FindKeyspace(ks)
if err != nil {
return nil, err
}
if keyspace == nil {
return nil, vterrors.Errorf(vtrpcpb.Code_UNAVAILABLE, "Cannot find keyspace for: %s", ks)
}
return &engine.Send{
Keyspace: keyspace,
TargetDestination: destination,
Query: sqlparser.String(explain),
SingleShardOnly: true,
}, nil
}
func buildVitessTypePlan(explain *sqlparser.ExplainStmt, reservedVars *sqlparser.ReservedVars, vschema plancontext.VSchema, enableOnlineDDL, enableDirectDDL bool) (engine.Primitive, error) {
innerInstruction, err := createInstructionFor(sqlparser.String(explain.Statement), explain.Statement, reservedVars, vschema, enableOnlineDDL, enableDirectDDL)
if err != nil {
return nil, err
}
descriptions := treeLines(engine.PrimitiveToPlanDescription(innerInstruction))
var rows [][]sqltypes.Value
for _, line := range descriptions {
var targetDest string
if line.descr.TargetDestination != nil {
targetDest = line.descr.TargetDestination.String()
}
keyspaceName := ""
if line.descr.Keyspace != nil {
keyspaceName = line.descr.Keyspace.Name
}
rows = append(rows, []sqltypes.Value{
sqltypes.NewVarChar(line.header + line.descr.OperatorType), // operator
sqltypes.NewVarChar(line.descr.Variant), // variant
sqltypes.NewVarChar(keyspaceName), // keyspace
sqltypes.NewVarChar(targetDest), // destination
sqltypes.NewVarChar(line.descr.TargetTabletType.String()), // tabletType
sqltypes.NewVarChar(extractQuery(line.descr.Other)), // query
})
}
fields := []*querypb.Field{
{Name: "operator", Type: querypb.Type_VARCHAR},
{Name: "variant", Type: querypb.Type_VARCHAR},
{Name: "keyspace", Type: querypb.Type_VARCHAR},
{Name: "destination", Type: querypb.Type_VARCHAR},
{Name: "tabletType", Type: querypb.Type_VARCHAR},
{Name: "query", Type: querypb.Type_VARCHAR},
}
return engine.NewRowsPrimitive(rows, fields), nil
}
func extractQuery(m map[string]any) string {
queryObj, ok := m["Query"]
if !ok {
return ""
}
query, ok := queryObj.(string)
if !ok {
return ""
}
return query
}
type description struct {
header string
descr engine.PrimitiveDescription
}
func treeLines(root engine.PrimitiveDescription) []description {
l := len(root.Inputs) - 1
output := []description{{
header: "",
descr: root,
}}
for i, child := range root.Inputs {
childLines := treeLines(child)
var header string
var lastHdr string
if i == l {
header = "└─" + " "
lastHdr = strings.Repeat(" ", 3)
} else {
header = "├─" + " "
lastHdr = "│" + strings.Repeat(" ", 2)
}
for x, childLine := range childLines {
if x == 0 {
childLine.header = header + childLine.header
} else {
childLine.header = lastHdr + childLine.header
}
output = append(output, childLine)
}
}
return output
}