Skip to content

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

refactor: convert WalkThrough methods to public functions (#18099)

Danny Xu0b52bed56113
diff --git a/backend/plugin/advisor/catalog/walk_through.go b/backend/plugin/advisor/catalog/walk_through.go
index 2f389b9792..97fe2947fd 100644
--- a/backend/plugin/advisor/catalog/walk_through.go
+++ b/backend/plugin/advisor/catalog/walk_through.go
@@ -179,14 +179,14 @@ func (e *WalkThroughError) Error() string {
}
// WalkThrough will collect the catalog schema in the databaseState as it walks through the stmt.
-func (d *DatabaseState) WalkThrough(ast any) error {
+func WalkThrough(d *DatabaseState, ast any) error {
switch d.dbType {
case storepb.Engine_TIDB:
- return d.tidbWalkThrough(ast)
+ return TiDBWalkThrough(d, ast)
case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE:
- return d.mysqlWalkThrough(ast)
+ return MySQLWalkThrough(d, ast)
case storepb.Engine_POSTGRES:
- if err := d.pgWalkThrough(ast); err != nil {
+ if err := PgWalkThrough(d, ast); err != nil {
if d.ctx.CheckIntegrity {
return err
}
diff --git a/backend/plugin/advisor/catalog/walk_through_for_mysql.go b/backend/plugin/advisor/catalog/walk_through_for_mysql.go
index a28e656bad..d77534cbb8 100644
--- a/backend/plugin/advisor/catalog/walk_through_for_mysql.go
+++ b/backend/plugin/advisor/catalog/walk_through_for_mysql.go
@@ -13,7 +13,8 @@ import (
"github.com/bytebase/bytebase/backend/plugin/parser/tidb"
)
-func (d *DatabaseState) mysqlWalkThrough(ast any) error {
+// MySQLWalkThrough walks through MySQL AST and updates the database state.
+func MySQLWalkThrough(d *DatabaseState, ast any) error {
// We define the Catalog as Database -> Schema -> Table. The Schema is only for PostgreSQL.
// So we use a Schema whose name is empty for other engines, such as MySQL.
// If there is no empty-string-name schema, create it to avoid corner cases.
diff --git a/backend/plugin/advisor/catalog/walk_through_for_pg.go b/backend/plugin/advisor/catalog/walk_through_for_pg.go
index b91ca418dc..75c2e4c6ea 100644
--- a/backend/plugin/advisor/catalog/walk_through_for_pg.go
+++ b/backend/plugin/advisor/catalog/walk_through_for_pg.go
@@ -12,8 +12,8 @@ import (
pgparser "github.com/bytebase/bytebase/backend/plugin/parser/pg"
)
-// pgWalkThrough walks through the ANTLR parse tree and builds catalog state.
-func (d *DatabaseState) pgWalkThrough(ast any) error {
+// PgWalkThrough walks through the PostgreSQL ANTLR parse tree and builds catalog state.
+func PgWalkThrough(d *DatabaseState, ast any) error {
// ANTLR-based walkthrough
parseResult, ok := ast.(*pgparser.ParseResult)
if !ok {
diff --git a/backend/plugin/advisor/catalog/walk_through_for_tidb.go b/backend/plugin/advisor/catalog/walk_through_for_tidb.go
index b87012e6ae..6c027f829b 100644
--- a/backend/plugin/advisor/catalog/walk_through_for_tidb.go
+++ b/backend/plugin/advisor/catalog/walk_through_for_tidb.go
@@ -11,7 +11,8 @@ import (
"github.com/pkg/errors"
)
-func (d *DatabaseState) tidbWalkThrough(ast any) error {
+// TiDBWalkThrough walks through TiDB AST and updates the database state.
+func TiDBWalkThrough(d *DatabaseState, ast any) error {
// We define the Catalog as Database -> Schema -> Table. The Schema is only for PostgreSQL.
// So we use a Schema whose name is empty for other engines, such as MySQL.
// If there is no empty-string-name schema, create it to avoid corner cases.
diff --git a/backend/plugin/advisor/catalog/walk_through_test.go b/backend/plugin/advisor/catalog/walk_through_test.go
index 4e1afcb571..c7cc7a26ba 100644
--- a/backend/plugin/advisor/catalog/walk_through_test.go
+++ b/backend/plugin/advisor/catalog/walk_through_test.go
@@ -202,7 +202,7 @@ func runWalkThroughTest(t *testing.T, file string, engineType storepb.Engine, or
}
asts, _ := sm.GetASTsForChecks(engineType, test.Statement)
- err := state.WalkThrough(asts)
+ err := WalkThrough(state, asts)
if err != nil {
err, yes := err.(*WalkThroughError)
require.True(t, yes)
@@ -257,7 +257,7 @@ func runANTLRWalkThroughTest(t *testing.T, file string, engineType storepb.Engin
}
// Call WalkThrough with ANTLR tree
- err := state.WalkThrough(parseResult)
+ err := WalkThrough(state, parseResult)
if err != nil {
err, yes := err.(*WalkThroughError)
require.True(t, yes)
diff --git a/backend/plugin/advisor/pg/pgantlr_test.go b/backend/plugin/advisor/pg/pgantlr_test.go
index c3e78a1592..3b172474ab 100644
--- a/backend/plugin/advisor/pg/pgantlr_test.go
+++ b/backend/plugin/advisor/pg/pgantlr_test.go
@@ -67,20 +67,6 @@ func TestPostgreSQLANTLRRules(t *testing.T) {
}
for _, rule := range antlrRules {
- needMetaData := advisorNeedMockData[rule]
- RunANTLRAdvisorRuleTest(t, rule, storepb.Engine_POSTGRES, needMetaData, false /* record */)
+ RunANTLRAdvisorRuleTest(t, rule, storepb.Engine_POSTGRES, false /* record */)
}
}
-
-// Add SQL review type here if you need metadata for test.
-var advisorNeedMockData = map[advisor.SQLReviewRuleType]bool{
- advisor.BuiltinRulePriorBackupCheck: true,
- advisor.SchemaRuleColumnNotNull: true, // Needs metadata for PRIMARY KEY USING INDEX case
- advisor.SchemaRuleFullyQualifiedObjectName: true, // Needs metadata for SELECT statement checks
- advisor.SchemaRuleIDXNaming: true, // Needs catalog for ALTER INDEX RENAME
- advisor.SchemaRuleIndexTotalNumberLimit: true, // Needs catalog to count indexes
- advisor.SchemaRulePKNaming: true, // Needs catalog for PRIMARY KEY USING INDEX
- advisor.SchemaRuleStatementObjectOwnerCheck: true, // Needs catalog for ownership checks
- advisor.SchemaRuleTableRequirePK: true, // Needs catalog for DROP CONSTRAINT/COLUMN checks
- advisor.SchemaRuleUKNaming: true, // Needs catalog for UNIQUE USING INDEX
-}
diff --git a/backend/plugin/advisor/pg/test_helper.go b/backend/plugin/advisor/pg/test_helper.go
index b6663d10dd..d55e0a324b 100644
--- a/backend/plugin/advisor/pg/test_helper.go
+++ b/backend/plugin/advisor/pg/test_helper.go
@@ -27,7 +27,7 @@ type TestCase struct {
// RunANTLRAdvisorRuleTest helps to test ANTLR-based SQL review rules.
// This is similar to advisor.RunSQLReviewRuleTest but for ANTLR advisors.
-func RunANTLRAdvisorRuleTest(t *testing.T, rule advisor.SQLReviewRuleType, dbType storepb.Engine, needMetaData bool, record bool) {
+func RunANTLRAdvisorRuleTest(t *testing.T, rule advisor.SQLReviewRuleType, dbType storepb.Engine, record bool) {
var tests []TestCase
fileName := strings.Map(func(r rune) rune {
@@ -51,13 +51,11 @@ func RunANTLRAdvisorRuleTest(t *testing.T, rule advisor.SQLReviewRuleType, dbTyp
for i, tc := range tests {
// Add engine types here for mocked database metadata.
var schemaMetadata *storepb.DatabaseSchemaMetadata
- if needMetaData {
- switch dbType {
- case storepb.Engine_POSTGRES:
- schemaMetadata = advisor.MockPostgreSQLDatabase
- default:
- t.Fatalf("%s doesn't have mocked metadata support", storepb.Engine_name[int32(dbType)])
- }
+ switch dbType {
+ case storepb.Engine_POSTGRES:
+ schemaMetadata = advisor.MockPostgreSQLDatabase
+ default:
+ t.Fatalf("%s doesn't have mocked metadata support", storepb.Engine_name[int32(dbType)])
}
database := advisor.MockPostgreSQLDatabase
@@ -76,11 +74,9 @@ func RunANTLRAdvisorRuleTest(t *testing.T, rule advisor.SQLReviewRuleType, dbTyp
tree, err := pg.ParsePostgreSQL(tc.Statement)
require.NoError(t, err, "Failed to parse SQL: %s", tc.Statement)
- // Use ANTLR tree for catalog WalkThrough
- if needMetaData {
- err = finalCatalog.WalkThrough(tree)
- require.NoError(t, err, "Failed to walk through final catalog: %s", tc.Statement)
- }
+ // Always walk through the catalog to build metadata.
+ err = catalog.WalkThrough(finalCatalog, tree)
+ require.NoError(t, err, "Failed to walk through final catalog: %s", tc.Statement)
ruleList := []*storepb.SQLReviewRule{
{
diff --git a/backend/plugin/advisor/sql_review.go b/backend/plugin/advisor/sql_review.go
index c1ebfca137..962e2bfdd8 100644
--- a/backend/plugin/advisor/sql_review.go
+++ b/backend/plugin/advisor/sql_review.go
@@ -534,7 +534,7 @@ func SQLReviewCheck(
if !builtinOnly && checkContext.FinalCatalog != nil {
switch checkContext.DBType {
case storepb.Engine_TIDB, storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_POSTGRES, storepb.Engine_OCEANBASE:
- if err := checkContext.FinalCatalog.WalkThrough(asts); err != nil {
+ if err := catalog.WalkThrough(checkContext.FinalCatalog, asts); err != nil {
return convertWalkThroughErrorToAdvice(err)
}
default: