forked from dolthub/go-mysql-server
-
Notifications
You must be signed in to change notification settings - Fork 0
/
stored_procedures.go
516 lines (480 loc) · 17 KB
/
stored_procedures.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
// Copyright 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 analyzer
import (
"fmt"
"strings"
"gopkg.in/src-d/go-errors.v1"
"github.com/gabereiser/go-mysql-server/sql"
"github.com/gabereiser/go-mysql-server/sql/expression"
"github.com/gabereiser/go-mysql-server/sql/parse"
"github.com/gabereiser/go-mysql-server/sql/plan"
"github.com/gabereiser/go-mysql-server/sql/transform"
)
// loadStoredProcedures loads non-built-in stored procedures for all databases on relevant calls.
func loadStoredProcedures(ctx *sql.Context, a *Analyzer, n sql.Node, scope *Scope, sel RuleSelector) (*Scope, error) {
if scope.proceduresPopulating() {
return scope, nil
}
referencesProcedures := hasProcedureCall(n)
if !referencesProcedures {
return scope, nil
}
scope = scope.withProcedureCache(NewProcedureCache())
scope.procedures.IsPopulating = true
defer func() {
scope.procedures.IsPopulating = false
}()
allDatabases := a.Catalog.AllDatabases(ctx)
for _, database := range allDatabases {
if pdb, ok := database.(sql.StoredProcedureDatabase); ok {
procedures, err := pdb.GetStoredProcedures(ctx)
if err != nil {
return nil, err
}
for _, procedure := range procedures {
parsedProcedure, err := parse.Parse(ctx, procedure.CreateStatement)
if err != nil {
return nil, err
}
cp, ok := parsedProcedure.(*plan.CreateProcedure)
if !ok {
return nil, sql.ErrProcedureCreateStatementInvalid.New(procedure.CreateStatement)
}
var procToRegister *plan.Procedure
analyzedProc, err := analyzeCreateProcedure(ctx, a, cp, scope, sel)
if err != nil {
procToRegister = cp.Procedure
procToRegister.ValidationError = err
} else {
procToRegister = analyzedProc
}
err = scope.procedures.Register(database.Name(), procToRegister)
if err != nil {
return nil, err
}
}
}
}
return scope, nil
}
// analyzeCreateProcedure checks the plan.CreateProcedure and returns a valid plan.Procedure or an error
func analyzeCreateProcedure(ctx *sql.Context, a *Analyzer, cp *plan.CreateProcedure, scope *Scope, sel RuleSelector) (*plan.Procedure, error) {
err := validateStoredProcedure(ctx, cp.Procedure)
if err != nil {
return nil, err
}
var analyzedNode sql.Node
analyzedNode, _, err = resolveDeclarations(ctx, a, cp.Procedure, scope, sel)
if err != nil {
return nil, err
}
analyzedNode, _, err = analyzeProcedureBodies(ctx, a, analyzedNode, false, scope, sel)
if err != nil {
return nil, err
}
analyzedProc, ok := analyzedNode.(*plan.Procedure)
if !ok {
return nil, fmt.Errorf("analyzed node %T and expected *plan.Procedure", analyzedNode)
}
return analyzedProc, nil
}
func hasProcedureCall(n sql.Node) bool {
referencesProcedures := false
transform.Inspect(n, func(n sql.Node) bool {
if _, ok := n.(*plan.Call); ok {
referencesProcedures = true
return false
} else if rt, ok := n.(*plan.ResolvedTable); ok {
_, rOk := rt.Table.(RoutineTable)
if rOk {
referencesProcedures = true
return false
}
}
return true
})
return referencesProcedures
}
// analyzeProcedureBodies analyzes each statement in a procedure's body individually, as the analyzer is designed to
// inspect single statements rather than a collection of statements, which is usually the body of a stored procedure.
func analyzeProcedureBodies(ctx *sql.Context, a *Analyzer, node sql.Node, skipCall bool, scope *Scope, sel RuleSelector) (sql.Node, transform.TreeIdentity, error) {
children := node.Children()
newChildren := make([]sql.Node, len(children))
var err error
procSel := NewProcRuleSelector(sel)
for i, child := range children {
var newChild sql.Node
switch child := child.(type) {
case plan.RepresentsBlock:
// Many analyzer rules only check the top-level node, so we have to recursively analyze each child
newChild, _, err = analyzeProcedureBodies(ctx, a, child, skipCall, scope, sel)
if err != nil {
return nil, transform.SameTree, err
}
// Blocks may have expressions declared directly on them, so we explicitly check the block node for variables
newChild, _, err = a.analyzeWithSelector(ctx, newChild, scope, SelectAllBatches, func(id RuleId) bool {
return id == resolveVariablesId
})
case *plan.Call:
if skipCall {
newChild = child
} else {
newChild, _, err = a.analyzeWithSelector(ctx, child, scope, SelectAllBatches, procSel)
}
default:
newChild, _, err = a.analyzeWithSelector(ctx, child, scope, SelectAllBatches, procSel)
}
if err != nil {
return nil, transform.SameTree, err
}
newChildren[i] = StripPassthroughNodes(newChild)
}
node, err = node.WithChildren(newChildren...)
if err != nil {
return nil, transform.SameTree, err
}
return node, transform.NewTree, nil
}
// validateCreateProcedure handles CreateProcedure nodes, resolving references to the parameters, along with ensuring
// that all logic contained within the stored procedure body is valid.
func validateCreateProcedure(ctx *sql.Context, a *Analyzer, node sql.Node, scope *Scope, sel RuleSelector) (sql.Node, transform.TreeIdentity, error) {
cp, ok := node.(*plan.CreateProcedure)
if !ok {
return node, transform.SameTree, nil
}
err := validateStoredProcedure(ctx, cp.Procedure)
if err != nil {
return nil, transform.SameTree, err
}
proc, _, err := resolveDeclarations(ctx, a, cp.Procedure, scope, sel)
if err != nil {
return nil, transform.SameTree, err
}
newProc, _, err := analyzeProcedureBodies(ctx, a, proc, true, nil, sel)
if err != nil {
return nil, transform.SameTree, err
}
node, err = cp.WithChildren(StripPassthroughNodes(newProc))
if err != nil {
return nil, transform.SameTree, err
}
return node, transform.NewTree, nil
}
// validateStoredProcedure handles Procedure nodes, resolving references to the parameters, along with ensuring
// that all logic contained within the stored procedure body is valid.
func validateStoredProcedure(_ *sql.Context, proc *plan.Procedure) error {
// For now, we don't support creating any of the following within stored procedures.
// These will be removed in the future, but cause issues with the current execution plan.
var err error
spUnsupportedErr := errors.NewKind("creating %s in stored procedures is currently unsupported " +
"and will be added in a future release")
transform.Inspect(proc, func(n sql.Node) bool {
switch n.(type) {
case *plan.CreateTable:
err = spUnsupportedErr.New("tables")
case *plan.CreateTrigger:
err = spUnsupportedErr.New("triggers")
case *plan.CreateProcedure:
err = spUnsupportedErr.New("procedures")
case *plan.CreateDB:
err = spUnsupportedErr.New("databases")
case *plan.CreateForeignKey:
err = spUnsupportedErr.New("foreign keys")
case *plan.CreateIndex:
err = spUnsupportedErr.New("indexes")
case *plan.CreateView:
err = spUnsupportedErr.New("views")
default:
return true
}
return false
})
if err != nil {
return err
}
transform.Inspect(proc, func(n sql.Node) bool {
switch n := n.(type) {
case *plan.Call:
if proc.Name == strings.ToLower(n.Name) {
err = sql.ErrProcedureRecursiveCall.New(proc.Name)
}
case *plan.LockTables: // Blocked in vitess, but this is for safety
err = sql.ErrProcedureInvalidBodyStatement.New("LOCK TABLES")
case *plan.UnlockTables: // Blocked in vitess, but this is for safety
err = sql.ErrProcedureInvalidBodyStatement.New("UNLOCK TABLES")
case *plan.Use: // Blocked in vitess, but this is for safety
err = sql.ErrProcedureInvalidBodyStatement.New("USE")
case *plan.LoadData:
err = sql.ErrProcedureInvalidBodyStatement.New("LOAD DATA")
default:
return true
}
return false
})
if err != nil {
return err
}
return nil
}
// applyProcedures applies the relevant stored procedures to the node given (if necessary).
func applyProcedures(ctx *sql.Context, a *Analyzer, n sql.Node, scope *Scope, sel RuleSelector) (sql.Node, transform.TreeIdentity, error) {
if _, ok := n.(*plan.CreateProcedure); ok {
return n, transform.SameTree, nil
}
hasProcedureCall := hasProcedureCall(n)
_, isShowCreateProcedure := n.(*plan.ShowCreateProcedure)
if !hasProcedureCall && !isShowCreateProcedure {
return n, transform.SameTree, nil
}
call, newIdentity, err := transform.Node(n, func(n sql.Node) (sql.Node, transform.TreeIdentity, error) {
call, ok := n.(*plan.Call)
if !ok {
return n, transform.SameTree, nil
}
if scope.IsEmpty() {
scope = scope.withProcedureCache(NewProcedureCache())
}
if call.AsOf() != nil && !scope.enforceReadOnly {
scope.enforceReadOnly = true
defer func() {
scope.enforceReadOnly = false
}()
}
esp, err := a.Catalog.ExternalStoredProcedure(ctx, call.Name, len(call.Params))
if err != nil {
return nil, transform.SameTree, err
}
if esp != nil {
externalProcedure, err := resolveExternalStoredProcedure(ctx, *esp)
if err != nil {
return nil, transform.SameTree, err
}
return call.WithProcedure(externalProcedure), transform.NewTree, nil
}
if spdb, ok := call.Database().(sql.StoredProcedureDatabase); ok {
procedure, ok, err := spdb.GetStoredProcedure(ctx, call.Name)
if err != nil {
return nil, transform.SameTree, err
}
if !ok {
err := sql.ErrStoredProcedureDoesNotExist.New(call.Name)
if call.Database().Name() == "" {
return nil, transform.SameTree, fmt.Errorf("%w; this might be because no database is selected", err)
}
return nil, transform.SameTree, err
}
parsedProcedure, err := parse.Parse(ctx, procedure.CreateStatement)
if err != nil {
return nil, transform.SameTree, err
}
parsedProcedure, _, err = transform.Node(parsedProcedure, func(n sql.Node) (sql.Node, transform.TreeIdentity, error) {
versionable, ok := n.(plan.Versionable)
if !ok {
return n, transform.SameTree, nil
}
tree := transform.SameTree
if newCall, ok := versionable.(*plan.Call); ok {
if newCall.Database() == nil || newCall.Database().Name() == "" {
newNode, err := newCall.WithDatabase(spdb)
if err != nil {
return nil, transform.SameTree, err
}
versionable = newNode.(plan.Versionable)
tree = transform.NewTree
}
}
if versionable.AsOf() == nil {
newNode, err := versionable.WithAsOf(call.AsOf())
if err != nil {
return nil, transform.SameTree, err
}
versionable = newNode.(plan.Versionable)
tree = transform.NewTree
}
return versionable, tree, nil
})
if err != nil {
return nil, transform.SameTree, err
}
cp, ok := parsedProcedure.(*plan.CreateProcedure)
if !ok {
return nil, transform.SameTree, sql.ErrProcedureCreateStatementInvalid.New(procedure.CreateStatement)
}
analyzedProc, err := analyzeCreateProcedure(ctx, a, cp, scope, sel)
if err != nil {
return nil, transform.SameTree, err
}
return call.WithProcedure(analyzedProc), transform.NewTree, nil
} else {
return nil, transform.SameTree, sql.ErrStoredProceduresNotSupported.New(call.Database().Name())
}
})
if err != nil {
return nil, transform.SameTree, err
}
n = call
return transform.Node(n, func(n sql.Node) (sql.Node, transform.TreeIdentity, error) {
switch n := n.(type) {
case *plan.Call:
return applyProceduresCall(ctx, a, n, scope, sel)
case *plan.ShowCreateProcedure:
procedures, err := a.Catalog.ExternalStoredProcedures(ctx, n.ProcedureName)
if err != nil {
return n, transform.SameTree, err
}
if len(procedures) == 0 {
// Not finding an external stored procedure is not an error, since we'll also later
// search for a user-defined stored procedure with this name.
return n, transform.SameTree, nil
}
return n.WithExternalStoredProcedure(procedures[0]), transform.NewTree, nil
default:
return n, newIdentity, nil
}
})
}
// applyProceduresCall applies the relevant stored procedure to the given *plan.Call.
func applyProceduresCall(ctx *sql.Context, a *Analyzer, call *plan.Call, scope *Scope, sel RuleSelector) (sql.Node, transform.TreeIdentity, error) {
var procedure *plan.Procedure
if call.Procedure == nil {
dbName := ctx.GetCurrentDatabase()
if call.Database() != nil {
dbName = call.Database().Name()
}
esp, err := a.Catalog.ExternalStoredProcedure(ctx, call.Name, len(call.Params))
if err != nil {
return nil, transform.SameTree, err
}
if esp != nil {
externalProcedure, err := resolveExternalStoredProcedure(ctx, *esp)
if err != nil {
return nil, false, err
}
procedure = externalProcedure
} else {
procedure = scope.procedures.Get(dbName, call.Name, len(call.Params))
}
if procedure == nil {
err := sql.ErrStoredProcedureDoesNotExist.New(call.Name)
if dbName == "" {
return nil, transform.SameTree, fmt.Errorf("%w; this might be because no database is selected", err)
}
return nil, transform.SameTree, err
}
if procedure.ValidationError != nil {
return nil, transform.SameTree, procedure.ValidationError
}
} else {
procedure = call.Procedure
}
if procedure.HasVariadicParameter() {
procedure = procedure.ExtendVariadic(ctx, len(call.Params))
}
pRef := expression.NewProcedureReference()
call = call.WithParamReference(pRef)
var procParamTransformFunc transform.ExprFunc
procParamTransformFunc = func(e sql.Expression) (sql.Expression, transform.TreeIdentity, error) {
switch expr := e.(type) {
case *expression.ProcedureParam:
return expr.WithParamReference(pRef), transform.NewTree, nil
case sql.ExpressionWithNodes:
children := expr.NodeChildren()
var newChildren []sql.Node
for i, child := range children {
newChild, same, err := transform.NodeExprsWithOpaque(child, procParamTransformFunc)
if err != nil {
return nil, transform.SameTree, err
}
if same == transform.NewTree {
if newChildren == nil {
newChildren = make([]sql.Node, len(children))
copy(newChildren, children)
}
newChildren[i] = newChild
}
}
if len(newChildren) > 0 {
newExpr, err := expr.WithNodeChildren(newChildren...)
if err != nil {
return nil, transform.SameTree, err
}
return newExpr, transform.NewTree, nil
}
return e, transform.SameTree, nil
default:
return e, transform.SameTree, nil
}
}
transformedProcedure, _, err := transform.NodeExprsWithOpaque(procedure, procParamTransformFunc)
if err != nil {
return nil, transform.SameTree, err
}
// Some nodes do not expose all of their children, so we need to handle them here.
transformedProcedure, _, err = transform.NodeWithOpaque(transformedProcedure, func(node sql.Node) (sql.Node, transform.TreeIdentity, error) {
switch n := node.(type) {
case plan.DisjointedChildrenNode:
same := transform.SameTree
disjointedChildGroups := n.DisjointedChildren()
newDisjointedChildGroups := make([][]sql.Node, len(disjointedChildGroups))
for groupIdx, disjointedChildGroup := range disjointedChildGroups {
newDisjointedChildGroups[groupIdx] = make([]sql.Node, len(disjointedChildGroup))
for childIdx, disjointedChild := range disjointedChildGroup {
var childIdentity transform.TreeIdentity
if newDisjointedChildGroups[groupIdx][childIdx], childIdentity, err = transform.NodeExprsWithOpaque(disjointedChild, procParamTransformFunc); err != nil {
return nil, transform.SameTree, err
} else if childIdentity == transform.NewTree {
same = childIdentity
}
}
}
if same == transform.NewTree {
if newChild, err := n.WithDisjointedChildren(newDisjointedChildGroups); err != nil {
return nil, transform.SameTree, err
} else {
return newChild, transform.NewTree, nil
}
}
return n, transform.SameTree, nil
case expression.ProcedureReferencable:
return n.WithParamReference(pRef), transform.NewTree, nil
default:
return transform.NodeExprsWithOpaque(n, procParamTransformFunc)
}
})
if err != nil {
return nil, transform.SameTree, err
}
transformedProcedure, _, err = transform.Node(transformedProcedure, func(node sql.Node) (sql.Node, transform.TreeIdentity, error) {
rt, ok := node.(*plan.ResolvedTable)
if !ok {
return node, transform.SameTree, nil
}
return plan.NewProcedureResolvedTable(rt), transform.NewTree, nil
})
transformedProcedure, _, err = applyProcedures(ctx, a, transformedProcedure, scope, sel)
if err != nil {
return nil, transform.SameTree, err
}
var ok bool
procedure, ok = transformedProcedure.(*plan.Procedure)
if !ok {
return nil, transform.SameTree, fmt.Errorf("expected `*plan.Procedure` but got `%T`", transformedProcedure)
}
if len(procedure.Params) != len(call.Params) {
return nil, transform.SameTree, sql.ErrCallIncorrectParameterCount.New(procedure.Name, len(procedure.Params), len(call.Params))
}
call = call.WithProcedure(procedure)
return call, transform.NewTree, nil
}