-
-
Notifications
You must be signed in to change notification settings - Fork 195
/
describe.go
165 lines (136 loc) · 4.4 KB
/
describe.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
// Copyright 2020-2021 Dolthub, 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 plan
import (
"github.com/dolthub/go-mysql-server/sql"
)
// Describe is a node that describes its children.
type Describe struct {
UnaryNode
}
var _ sql.Node = (*Describe)(nil)
var _ sql.CollationCoercible = (*Describe)(nil)
// NewDescribe creates a new Describe node.
func NewDescribe(child sql.Node) *Describe {
return &Describe{UnaryNode{child}}
}
// Schema implements the Node interface.
func (d *Describe) Schema() sql.Schema {
return sql.Schema{{
Name: "name",
Type: VarChar25000,
}, {
Name: "type",
Type: VarChar25000,
}}
}
func (d *Describe) IsReadOnly() bool {
return true
}
// WithChildren implements the Node interface.
func (d *Describe) WithChildren(children ...sql.Node) (sql.Node, error) {
if len(children) != 1 {
return nil, sql.ErrInvalidChildrenNumber.New(d, len(children), 1)
}
return NewDescribe(children[0]), nil
}
// CheckPrivileges implements the interface sql.Node.
func (d *Describe) CheckPrivileges(ctx *sql.Context, opChecker sql.PrivilegedOperationChecker) bool {
return d.Child.CheckPrivileges(ctx, opChecker)
}
// CollationCoercibility implements the interface sql.CollationCoercible.
func (*Describe) CollationCoercibility(ctx *sql.Context) (collation sql.CollationID, coercibility byte) {
return sql.Collation_binary, 7
}
func (d Describe) String() string {
p := sql.NewTreePrinter()
_ = p.WriteNode("Describe")
_ = p.WriteChildren(d.Child.String())
return p.String()
}
// DescribeQuery returns the description of the query plan.
type DescribeQuery struct {
UnaryNode
Format sql.DescribeOptions
}
var _ sql.Node = (*DescribeQuery)(nil)
var _ sql.CollationCoercible = (*DescribeQuery)(nil)
func (d *DescribeQuery) Resolved() bool {
return d.Child.Resolved()
}
func (d *DescribeQuery) IsReadOnly() bool {
return true
}
func (d *DescribeQuery) Children() []sql.Node {
return nil
}
func (d *DescribeQuery) WithChildren(node ...sql.Node) (sql.Node, error) {
if len(node) > 0 {
return nil, sql.ErrInvalidChildrenNumber.New(d, len(node), 0)
}
return d, nil
}
// CheckPrivileges implements the interface sql.Node.
func (d *DescribeQuery) CheckPrivileges(ctx *sql.Context, opChecker sql.PrivilegedOperationChecker) bool {
return d.Child.CheckPrivileges(ctx, opChecker)
}
// CollationCoercibility implements the interface sql.CollationCoercible.
func (*DescribeQuery) CollationCoercibility(ctx *sql.Context) (collation sql.CollationID, coercibility byte) {
return sql.Collation_binary, 7
}
// DescribeSchema is the schema returned by a DescribeQuery node.
var DescribeSchema = sql.Schema{
{Name: "plan", Type: VarChar25000},
}
// NewDescribeQuery creates a new DescribeQuery node.
func NewDescribeQuery(format sql.DescribeOptions, child sql.Node) *DescribeQuery {
return &DescribeQuery{UnaryNode{Child: child}, format}
}
// Schema implements the Node interface.
func (d *DescribeQuery) Schema() sql.Schema {
return DescribeSchema
}
func (d *DescribeQuery) Describe(options sql.DescribeOptions) string {
pr := sql.NewTreePrinter()
_ = pr.WriteNode("DescribeQuery(format=%s)", d.Format)
options.Estimates = d.Format.Estimates || options.Estimates
options.Analyze = d.Format.Analyze || options.Analyze
options.Debug = d.Format.Debug || options.Debug
_ = pr.WriteChildren(sql.Describe(d.Child, options))
return pr.String()
}
func (d *DescribeQuery) String() string {
return d.Describe(sql.DescribeOptions{
Analyze: false,
Estimates: false,
Debug: false,
})
}
func (d *DescribeQuery) DebugString() string {
return d.Describe(sql.DescribeOptions{
Analyze: false,
Estimates: false,
Debug: true,
})
}
// Query returns the query node being described
func (d *DescribeQuery) Query() sql.Node {
return d.Child
}
// WithQuery returns a copy of this node with the query node given
func (d *DescribeQuery) WithQuery(child sql.Node) sql.Node {
res := *d
res.Child = child
return &res
}