Skip to content

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

refactor: consolidate PostgreSQL statement type functions (#17981)

h3n4l209862a5f271
diff --git a/backend/api/v1/release_service_check.go b/backend/api/v1/release_service_check.go
index e41305c3d2..0163a1b922 100644
--- a/backend/api/v1/release_service_check.go
+++ b/backend/api/v1/release_service_check.go
@@ -655,7 +655,7 @@ type statementTypeWithPosition struct {
func getStatementTypesWithPositionsForEngine(engine storepb.Engine, asts any) ([]statementTypeWithPosition, error) {
switch engine {
case storepb.Engine_POSTGRES, storepb.Engine_COCKROACHDB, storepb.Engine_REDSHIFT:
- pgStmts, err := pg.GetStatementTypesWithPositions(asts)
+ pgStmts, err := pg.GetStatementTypes(asts)
if err != nil {
return nil, err
}
diff --git a/backend/plugin/parser/pg/statement_type.go b/backend/plugin/parser/pg/statement_type.go
index c3fdc747be..160e416c82 100644
--- a/backend/plugin/parser/pg/statement_type.go
+++ b/backend/plugin/parser/pg/statement_type.go
@@ -1,6 +1,7 @@
package pg
import (
+ "github.com/antlr4-go/antlr/v4"
"github.com/pkg/errors"
)
@@ -12,20 +13,23 @@ type StatementTypeWithPosition struct {
Text string
}
-func GetStatementTypes(asts any) ([]string, error) {
+// GetStatementTypes returns statement types with position information.
+// The line numbers are one-based.
+func GetStatementTypes(asts any) ([]StatementTypeWithPosition, error) {
parseResult, ok := asts.(*ParseResult)
if !ok {
return nil, errors.Errorf("invalid ast type %T, expected *ParseResult", asts)
}
- return GetStatementTypesANTLR(parseResult)
-}
-// GetStatementTypesWithPositions returns statement types with position information.
-// The line numbers are one-based.
-func GetStatementTypesWithPositions(asts any) ([]StatementTypeWithPosition, error) {
- parseResult, ok := asts.(*ParseResult)
- if !ok {
- return nil, errors.Errorf("invalid ast type %T, expected *ParseResult", asts)
+ if parseResult == nil || parseResult.Tree == nil {
+ return nil, errors.New("invalid parse result")
+ }
+
+ collector := &statementTypeCollectorWithPosition{
+ tokens: parseResult.Tokens,
}
- return GetStatementTypesWithPositionsANTLR(parseResult)
+
+ antlr.ParseTreeWalkerDefault.Walk(collector, parseResult.Tree)
+
+ return collector.results, nil
}
diff --git a/backend/plugin/parser/pg/statement_type_antlr.go b/backend/plugin/parser/pg/statement_type_antlr.go
index 2c60006749..ccdb4b74d3 100644
--- a/backend/plugin/parser/pg/statement_type_antlr.go
+++ b/backend/plugin/parser/pg/statement_type_antlr.go
@@ -3,49 +3,8 @@ package pg
import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
- "github.com/pkg/errors"
)
-// GetStatementTypesANTLR returns statement types from ANTLR parse result.
-func GetStatementTypesANTLR(parseResult *ParseResult) ([]string, error) {
- if parseResult == nil || parseResult.Tree == nil {
- return nil, errors.New("invalid parse result")
- }
-
- collector := &statementTypeCollector{
- types: make(map[string]bool),
- }
-
- antlr.ParseTreeWalkerDefault.Walk(collector, parseResult.Tree)
-
- var sqlTypes []string
- for sqlType := range collector.types {
- sqlTypes = append(sqlTypes, sqlType)
- }
- return sqlTypes, nil
-}
-
-// GetStatementTypesWithPositionsANTLR returns statement types with position information from ANTLR parse result.
-func GetStatementTypesWithPositionsANTLR(parseResult *ParseResult) ([]StatementTypeWithPosition, error) {
- if parseResult == nil || parseResult.Tree == nil {
- return nil, errors.New("invalid parse result")
- }
-
- collector := &statementTypeCollectorWithPosition{
- tokens: parseResult.Tokens,
- }
-
- antlr.ParseTreeWalkerDefault.Walk(collector, parseResult.Tree)
-
- return collector.results, nil
-}
-
-// statementTypeCollector collects unique statement types.
-type statementTypeCollector struct {
- *parser.BasePostgreSQLParserListener
- types map[string]bool
-}
-
// statementTypeCollectorWithPosition collects statement types with positions.
type statementTypeCollectorWithPosition struct {
*parser.BasePostgreSQLParserListener
@@ -53,13 +12,6 @@ type statementTypeCollectorWithPosition struct {
results []StatementTypeWithPosition
}
-// Helper function to add statement type.
-func (c *statementTypeCollector) addType(stmtType string) {
- if stmtType != "" && stmtType != "UNKNOWN" {
- c.types[stmtType] = true
- }
-}
-
// Helper function to add statement with position.
func (c *statementTypeCollectorWithPosition) addStatement(stmtType string, ctx antlr.ParserRuleContext) {
if stmtType == "" || stmtType == "UNKNOWN" {
@@ -89,13 +41,6 @@ func (c *statementTypeCollectorWithPosition) addStatement(stmtType string, ctx a
}
// CREATE TABLE statements
-func (c *statementTypeCollector) EnterCreatestmt(ctx *parser.CreatestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_TABLE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreatestmt(ctx *parser.CreatestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -104,13 +49,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreatestmt(ctx *parser.Creates
}
// CREATE VIEW statements
-func (c *statementTypeCollector) EnterViewstmt(ctx *parser.ViewstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_VIEW")
-}
-
func (c *statementTypeCollectorWithPosition) EnterViewstmt(ctx *parser.ViewstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -119,13 +57,6 @@ func (c *statementTypeCollectorWithPosition) EnterViewstmt(ctx *parser.ViewstmtC
}
// CREATE INDEX statements
-func (c *statementTypeCollector) EnterIndexstmt(ctx *parser.IndexstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_INDEX")
-}
-
func (c *statementTypeCollectorWithPosition) EnterIndexstmt(ctx *parser.IndexstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -134,13 +65,6 @@ func (c *statementTypeCollectorWithPosition) EnterIndexstmt(ctx *parser.Indexstm
}
// CREATE SEQUENCE statements
-func (c *statementTypeCollector) EnterCreateseqstmt(ctx *parser.CreateseqstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_SEQUENCE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreateseqstmt(ctx *parser.CreateseqstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -149,13 +73,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreateseqstmt(ctx *parser.Crea
}
// CREATE SCHEMA statements
-func (c *statementTypeCollector) EnterCreateschemastmt(ctx *parser.CreateschemastmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_SCHEMA")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreateschemastmt(ctx *parser.CreateschemastmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -164,13 +81,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreateschemastmt(ctx *parser.C
}
// CREATE FUNCTION statements
-func (c *statementTypeCollector) EnterCreatefunctionstmt(ctx *parser.CreatefunctionstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_FUNCTION")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreatefunctionstmt(ctx *parser.CreatefunctionstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -179,13 +89,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreatefunctionstmt(ctx *parser
}
// CREATE TRIGGER statements
-func (c *statementTypeCollector) EnterCreatetrigstmt(ctx *parser.CreatetrigstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_TRIGGER")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreatetrigstmt(ctx *parser.CreatetrigstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -194,13 +97,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreatetrigstmt(ctx *parser.Cre
}
// CREATE EXTENSION statements
-func (c *statementTypeCollector) EnterCreateextensionstmt(ctx *parser.CreateextensionstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_EXTENSION")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreateextensionstmt(ctx *parser.CreateextensionstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -209,13 +105,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreateextensionstmt(ctx *parse
}
// CREATE DATABASE statements
-func (c *statementTypeCollector) EnterCreatedbstmt(ctx *parser.CreatedbstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("CREATE_DATABASE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCreatedbstmt(ctx *parser.CreatedbstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -224,13 +113,6 @@ func (c *statementTypeCollectorWithPosition) EnterCreatedbstmt(ctx *parser.Creat
}
// DROP statements
-func (c *statementTypeCollector) EnterDropstmt(ctx *parser.DropstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType(getDropStatementType(ctx))
-}
-
func (c *statementTypeCollectorWithPosition) EnterDropstmt(ctx *parser.DropstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -239,29 +121,6 @@ func (c *statementTypeCollectorWithPosition) EnterDropstmt(ctx *parser.DropstmtC
}
// ALTER statements
-func (c *statementTypeCollector) EnterAltertablestmt(ctx *parser.AltertablestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
-
- // Check if this is ALTER VIEW
- if ctx.VIEW() != nil {
- c.addType("ALTER_VIEW")
- return
- }
-
- // Parse ALTER TABLE sub-operations if alter_table_cmds exists
- if cmds := ctx.Alter_table_cmds(); cmds != nil {
- for _, cmd := range cmds.AllAlter_table_cmd() {
- stmtType := getAlterTableCmdType(cmd)
- c.addType(stmtType)
- }
- } else {
- // Fallback to generic ALTER_TABLE if no cmds
- c.addType("ALTER_TABLE")
- }
-}
-
func (c *statementTypeCollectorWithPosition) EnterAltertablestmt(ctx *parser.AltertablestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -285,13 +144,6 @@ func (c *statementTypeCollectorWithPosition) EnterAltertablestmt(ctx *parser.Alt
}
}
-func (c *statementTypeCollector) EnterAlterseqstmt(ctx *parser.AlterseqstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("ALTER_SEQUENCE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterAlterseqstmt(ctx *parser.AlterseqstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -299,13 +151,6 @@ func (c *statementTypeCollectorWithPosition) EnterAlterseqstmt(ctx *parser.Alter
c.addStatement("ALTER_SEQUENCE", ctx)
}
-func (c *statementTypeCollector) EnterAlterenumstmt(ctx *parser.AlterenumstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("ALTER_TYPE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterAlterenumstmt(ctx *parser.AlterenumstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -314,13 +159,6 @@ func (c *statementTypeCollectorWithPosition) EnterAlterenumstmt(ctx *parser.Alte
}
// RENAME statements
-func (c *statementTypeCollector) EnterRenamestmt(ctx *parser.RenamestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType(getRenameStatementType(ctx))
-}
-
func (c *statementTypeCollectorWithPosition) EnterRenamestmt(ctx *parser.RenamestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -329,13 +167,6 @@ func (c *statementTypeCollectorWithPosition) EnterRenamestmt(ctx *parser.Renames
}
// COMMENT statements
-func (c *statementTypeCollector) EnterCommentstmt(ctx *parser.CommentstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("COMMENT")
-}
-
func (c *statementTypeCollectorWithPosition) EnterCommentstmt(ctx *parser.CommentstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -344,16 +175,6 @@ func (c *statementTypeCollectorWithPosition) EnterCommentstmt(ctx *parser.Commen
}
// CREATE TYPE statements
-func (c *statementTypeCollector) EnterDefinestmt(ctx *parser.DefinestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- // Check if this is CREATE TYPE
- if ctx.TYPE_P() != nil {
- c.addType("CREATE_TYPE")
- }
-}
-
func (c *statementTypeCollectorWithPosition) EnterDefinestmt(ctx *parser.DefinestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -365,13 +186,6 @@ func (c *statementTypeCollectorWithPosition) EnterDefinestmt(ctx *parser.Defines
}
// DROP FUNCTION statements
-func (c *statementTypeCollector) EnterRemovefuncstmt(ctx *parser.RemovefuncstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("DROP_FUNCTION")
-}
-
func (c *statementTypeCollectorWithPosition) EnterRemovefuncstmt(ctx *parser.RemovefuncstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -380,13 +194,6 @@ func (c *statementTypeCollectorWithPosition) EnterRemovefuncstmt(ctx *parser.Rem
}
// DROP DATABASE statements
-func (c *statementTypeCollector) EnterDropdbstmt(ctx *parser.DropdbstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("DROP_DATABASE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterDropdbstmt(ctx *parser.DropdbstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -395,13 +202,6 @@ func (c *statementTypeCollectorWithPosition) EnterDropdbstmt(ctx *parser.Dropdbs
}
// DML statements
-func (c *statementTypeCollector) EnterInsertstmt(ctx *parser.InsertstmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("INSERT")
-}
-
func (c *statementTypeCollectorWithPosition) EnterInsertstmt(ctx *parser.InsertstmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -409,13 +209,6 @@ func (c *statementTypeCollectorWithPosition) EnterInsertstmt(ctx *parser.Inserts
c.addStatement("INSERT", ctx)
}
-func (c *statementTypeCollector) EnterUpdatestmt(ctx *parser.UpdatestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("UPDATE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterUpdatestmt(ctx *parser.UpdatestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
@@ -423,13 +216,6 @@ func (c *statementTypeCollectorWithPosition) EnterUpdatestmt(ctx *parser.Updates
c.addStatement("UPDATE", ctx)
}
-func (c *statementTypeCollector) EnterDeletestmt(ctx *parser.DeletestmtContext) {
- if !isTopLevel(ctx.GetParent()) {
- return
- }
- c.addType("DELETE")
-}
-
func (c *statementTypeCollectorWithPosition) EnterDeletestmt(ctx *parser.DeletestmtContext) {
if !isTopLevel(ctx.GetParent()) {
return
diff --git a/backend/plugin/parser/pg/statement_type_antlr_test.go b/backend/plugin/parser/pg/statement_type_antlr_test.go
index 778a7c2594..73dbd05d18 100644
--- a/backend/plugin/parser/pg/statement_type_antlr_test.go
+++ b/backend/plugin/parser/pg/statement_type_antlr_test.go
@@ -221,14 +221,20 @@ func TestGetStatementTypesANTLR(t *testing.T) {
parseResult, err := ParsePostgreSQL(tt.sql)
require.NoError(t, err)
- types, err := GetStatementTypesANTLR(parseResult)
+ stmtsWithPos, err := GetStatementTypes(parseResult)
require.NoError(t, err)
+
+ // Extract types from statements with positions
+ types := make([]string, len(stmtsWithPos))
+ for i, stmt := range stmtsWithPos {
+ types[i] = stmt.Type
+ }
require.ElementsMatch(t, tt.expectedTypes, types)
})
}
}
-func TestGetStatementTypesWithPositionsANTLR(t *testing.T) {
+func TestGetStatementTypesWithPositions(t *testing.T) {
tests := []struct {
name string
sql string
@@ -272,7 +278,7 @@ INSERT INTO t1 VALUES (1);`,
parseResult, err := ParsePostgreSQL(tt.sql)
require.NoError(t, err)
- results, err := GetStatementTypesWithPositionsANTLR(parseResult)
+ results, err := GetStatementTypes(parseResult)
require.NoError(t, err)
require.Len(t, results, len(tt.expected))
diff --git a/backend/runner/plancheck/statement_report_executor.go b/backend/runner/plancheck/statement_report_executor.go
index fc089504b6..ca4be3e012 100644
--- a/backend/runner/plancheck/statement_report_executor.go
+++ b/backend/runner/plancheck/statement_report_executor.go
@@ -186,10 +186,14 @@ func GetSQLSummaryReport(ctx context.Context, stores *store.Store, sheetManager
}
explainCalculator = pd.CountAffectedRows
- sqlTypes, err = pg.GetStatementTypes(asts)
+ stmtsWithPos, err := pg.GetStatementTypes(asts)
if err != nil {
return nil, err
}
+ sqlTypes = make([]string, len(stmtsWithPos))
+ for i, stmt := range stmtsWithPos {
+ sqlTypes[i] = stmt.Type
+ }
defaultSchema = "public"
case storepb.Engine_REDSHIFT:
rd, ok := driver.(*redshiftdriver.Driver)