Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

refactor(parser/mysql): migrate statement type detection to omni AST [BYT-9115] (#19833)

rebelice1b72da34e6df
diff --git a/backend/plugin/parser/mysql/statement_type.go b/backend/plugin/parser/mysql/statement_type.go
index 7ac9efacc2..d9b51f015b 100644
--- a/backend/plugin/parser/mysql/statement_type.go
+++ b/backend/plugin/parser/mysql/statement_type.go
@@ -1,7 +1,7 @@
package mysql
import (
- "github.com/bytebase/parser/mysql"
+ "github.com/bytebase/omni/mysql/ast"
"github.com/pkg/errors"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
@@ -10,12 +10,12 @@ import (
func GetStatementTypes(asts []base.AST) ([]storepb.StatementType, error) {
sqlTypeSet := make(map[storepb.StatementType]bool)
- for _, ast := range asts {
- antlrAST, ok := base.GetANTLRAST(ast)
+ for _, a := range asts {
+ node, ok := GetOmniNode(a)
if !ok {
- return nil, errors.New("expected ANTLR AST for MySQL")
+ return nil, errors.New("expected OmniAST for MySQL")
}
- t := getStatementType(antlrAST)
+ t := classifyStatementType(node)
sqlTypeSet[t] = true
}
var sqlTypes []storepb.StatementType
@@ -25,91 +25,71 @@ func GetStatementTypes(asts []base.AST) ([]storepb.StatementType, error) {
return sqlTypes, nil
}
-// GetStatementType return the type of statement.
-func getStatementType(stmt *base.ANTLRAST) storepb.StatementType {
- for _, child := range stmt.Tree.GetChildren() {
- switch ctx := child.(type) {
- case *mysql.QueryContext:
- for _, child := range ctx.GetChildren() {
- switch ctx := child.(type) {
- case *mysql.SimpleStatementContext:
- for _, child := range ctx.GetChildren() {
- switch ctx := child.(type) {
- case *mysql.CreateStatementContext:
- for _, child := range ctx.GetChildren() {
- switch child.(type) {
- case *mysql.CreateDatabaseContext:
- return storepb.StatementType_CREATE_DATABASE
- case *mysql.CreateIndexContext:
- return storepb.StatementType_CREATE_INDEX
- case *mysql.CreateTableContext:
- return storepb.StatementType_CREATE_TABLE
- case *mysql.CreateViewContext:
- return storepb.StatementType_CREATE_VIEW
- case *mysql.CreateEventContext:
- return storepb.StatementType_CREATE_EVENT
- case *mysql.CreateTriggerContext:
- return storepb.StatementType_CREATE_TRIGGER
- case *mysql.CreateFunctionContext:
- return storepb.StatementType_CREATE_FUNCTION
- case *mysql.CreateProcedureContext:
- return storepb.StatementType_CREATE_PROCEDURE
- }
- }
- case *mysql.DropStatementContext:
- for _, child := range ctx.GetChildren() {
- switch child.(type) {
- case *mysql.DropIndexContext:
- return storepb.StatementType_DROP_INDEX
- case *mysql.DropTableContext:
- return storepb.StatementType_DROP_TABLE
- case *mysql.DropDatabaseContext:
- return storepb.StatementType_DROP_DATABASE
- case *mysql.DropViewContext:
- return storepb.StatementType_DROP_VIEW
- case *mysql.DropTriggerContext:
- return storepb.StatementType_DROP_TRIGGER
- case *mysql.DropEventContext:
- return storepb.StatementType_DROP_EVENT
- case *mysql.DropFunctionContext:
- return storepb.StatementType_DROP_FUNCTION
- case *mysql.DropProcedureContext:
- return storepb.StatementType_DROP_PROCEDURE
- }
- }
- case *mysql.AlterStatementContext:
- for _, child := range ctx.GetChildren() {
- switch child.(type) {
- case *mysql.AlterTableContext:
- return storepb.StatementType_ALTER_TABLE
- case *mysql.AlterDatabaseContext:
- return storepb.StatementType_ALTER_DATABASE
- case *mysql.AlterViewContext:
- return storepb.StatementType_ALTER_VIEW
- case *mysql.AlterEventContext:
- return storepb.StatementType_ALTER_EVENT
- }
- }
- case *mysql.TruncateTableStatementContext:
- return storepb.StatementType_TRUNCATE
- case *mysql.RenameTableStatementContext:
- return storepb.StatementType_RENAME
+func classifyStatementType(node ast.Node) storepb.StatementType {
+ switch n := node.(type) {
+ // CREATE
+ case *ast.CreateDatabaseStmt:
+ return storepb.StatementType_CREATE_DATABASE
+ case *ast.CreateTableStmt:
+ return storepb.StatementType_CREATE_TABLE
+ case *ast.CreateIndexStmt:
+ return storepb.StatementType_CREATE_INDEX
+ case *ast.CreateViewStmt:
+ return storepb.StatementType_CREATE_VIEW
+ case *ast.CreateEventStmt:
+ return storepb.StatementType_CREATE_EVENT
+ case *ast.CreateTriggerStmt:
+ return storepb.StatementType_CREATE_TRIGGER
+ case *ast.CreateFunctionStmt:
+ if n.IsProcedure {
+ return storepb.StatementType_CREATE_PROCEDURE
+ }
+ return storepb.StatementType_CREATE_FUNCTION
- // dml.
- case *mysql.DeleteStatementContext:
- return storepb.StatementType_DELETE
- case *mysql.InsertStatementContext:
- return storepb.StatementType_INSERT
- case *mysql.UpdateStatementContext:
- return storepb.StatementType_UPDATE
- default:
- }
- }
- default:
- }
- }
- default:
+ // DROP
+ case *ast.DropDatabaseStmt:
+ return storepb.StatementType_DROP_DATABASE
+ case *ast.DropTableStmt:
+ return storepb.StatementType_DROP_TABLE
+ case *ast.DropIndexStmt:
+ return storepb.StatementType_DROP_INDEX
+ case *ast.DropViewStmt:
+ return storepb.StatementType_DROP_VIEW
+ case *ast.DropEventStmt:
+ return storepb.StatementType_DROP_EVENT
+ case *ast.DropTriggerStmt:
+ return storepb.StatementType_DROP_TRIGGER
+ case *ast.DropRoutineStmt:
+ if n.IsProcedure {
+ return storepb.StatementType_DROP_PROCEDURE
}
+ return storepb.StatementType_DROP_FUNCTION
+
+ // ALTER
+ case *ast.AlterTableStmt:
+ return storepb.StatementType_ALTER_TABLE
+ case *ast.AlterDatabaseStmt:
+ return storepb.StatementType_ALTER_DATABASE
+ case *ast.AlterViewStmt:
+ return storepb.StatementType_ALTER_VIEW
+ case *ast.AlterEventStmt:
+ return storepb.StatementType_ALTER_EVENT
+
+ // OTHER DDL
+ case *ast.TruncateStmt:
+ return storepb.StatementType_TRUNCATE
+ case *ast.RenameTableStmt:
+ return storepb.StatementType_RENAME
+
+ // DML
+ case *ast.InsertStmt:
+ return storepb.StatementType_INSERT
+ case *ast.UpdateStmt:
+ return storepb.StatementType_UPDATE
+ case *ast.DeleteStmt:
+ return storepb.StatementType_DELETE
+
+ default:
+ return storepb.StatementType_STATEMENT_TYPE_UNSPECIFIED
}
- return storepb.StatementType_STATEMENT_TYPE_UNSPECIFIED
}
diff --git a/backend/plugin/parser/mysql/statement_type_check.go b/backend/plugin/parser/mysql/statement_type_check.go
deleted file mode 100644
index 33a7e02542..0000000000
--- a/backend/plugin/parser/mysql/statement_type_check.go
+++ /dev/null
@@ -1,197 +0,0 @@
-package mysql
-
-import (
- "github.com/bytebase/parser/mysql"
-)
-
-type StatementTypeChecker struct {
- *mysql.BaseMySQLParserListener
-
- IsDDL bool
- IsDML bool
- IsExplain bool
- Text string
-}
-
-func (checker *StatementTypeChecker) EnterQuery(ctx *mysql.QueryContext) {
- checker.Text = ctx.GetParser().GetTokenStream().GetTextFromRuleContext(ctx)
-}
-
-// DDL from g4
-// alterStatement
-// createStatement
-// dropStatement
-// renameTableStatement
-// truncateTableStatement
-// importStatement
-// EnterAlterStatement is called when production alterStatement is entered.
-func (checker *StatementTypeChecker) EnterAlterStatement(ctx *mysql.AlterStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterCreateStatement is called when production createStatement is entered.
-func (checker *StatementTypeChecker) EnterCreateStatement(ctx *mysql.CreateStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterDropStatement is called when production dropStatement is entered.
-func (checker *StatementTypeChecker) EnterDropStatement(ctx *mysql.DropStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterRenameTableStatement is called when production renameTableStatement is entered.
-func (checker *StatementTypeChecker) EnterRenameTableStatement(ctx *mysql.RenameTableStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterTruncateTableStatement is called when production truncateTableStatement is entered.
-func (checker *StatementTypeChecker) EnterTruncateTableStatement(ctx *mysql.TruncateTableStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterImportStatement is called when production importStatement is entered.
-func (checker *StatementTypeChecker) EnterImportStatement(ctx *mysql.ImportStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// EnterExplainStatement is called when production explainStatement is entered.
-func (checker *StatementTypeChecker) EnterExplainStatement(ctx *mysql.ExplainStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDDL = true
- }
- }
-}
-
-// DML
-// EnterCallStatement is called when production callStatement is entered.
-func (checker *StatementTypeChecker) EnterCallStatement(ctx *mysql.CallStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterDeleteStatement is called when production deleteStatement is entered.
-func (checker *StatementTypeChecker) EnterDeleteStatement(ctx *mysql.DeleteStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterDoStatement is called when production doStatement is entered.
-func (checker *StatementTypeChecker) EnterDoStatement(ctx *mysql.DoStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterHandlerStatement is called when production handlerStatement is entered.
-func (checker *StatementTypeChecker) EnterHandlerStatement(ctx *mysql.HandlerStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterInsertStatement is called when production insertStatement is entered.
-func (checker *StatementTypeChecker) EnterInsertStatement(ctx *mysql.InsertStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterLoadDataFileTail is called when production loadDataFileTail is entered.
-func (checker *StatementTypeChecker) EnterLoadDataFileTail(ctx *mysql.LoadDataFileTailContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterReplaceStatement is called when production replaceStatement is entered.
-func (checker *StatementTypeChecker) EnterReplaceStatement(ctx *mysql.ReplaceStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterSelectStatement is called when production selectStatement is entered.
-func (checker *StatementTypeChecker) EnterSelectStatement(ctx *mysql.SelectStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterUpdateStatement is called when production updateStatement is entered.
-func (checker *StatementTypeChecker) EnterUpdateStatement(ctx *mysql.UpdateStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterTransactionOrLockingStatement is called when production transactionOrLockingStatement is entered.
-func (checker *StatementTypeChecker) EnterTransactionOrLockingStatement(ctx *mysql.TransactionOrLockingStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterReplicationStatement is called when production replicationStatement is entered.
-func (checker *StatementTypeChecker) EnterReplicationStatement(ctx *mysql.ReplicationStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}
-
-// EnterPreparedStatement is called when production preparedStatement is entered.
-func (checker *StatementTypeChecker) EnterPreparedStatement(ctx *mysql.PreparedStatementContext) {
- if parent, ok := ctx.GetParent().(*mysql.SimpleStatementContext); ok {
- if _, ok := parent.GetParent().(*mysql.QueryContext); ok {
- checker.IsDML = true
- }
- }
-}