Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
fix(starrocks): sweep the Engine_DORIS-dispatch class (driver + parser) (#20566)
Vincent Huang621dc964a8b4
diff --git a/backend/plugin/db/starrocks/dispatch_test.go b/backend/plugin/db/starrocks/dispatch_test.gonew file mode 100644index 0000000000..3d6a4063bc--- /dev/null+++ b/backend/plugin/db/starrocks/dispatch_test.go@@ -0,0 +1,31 @@+package starrocks++import (+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+ "github.com/bytebase/bytebase/backend/plugin/parser/base"++ // Register the doris + starrocks editor validators.+ _ "github.com/bytebase/bytebase/backend/plugin/parser/doris"+ _ "github.com/bytebase/bytebase/backend/plugin/parser/starrocks"+)++// TestValidateSQLForEditor_EngineDispatch guards the #20562 P2 fix: QueryConn+// must split/validate via the connection's engine (d.dbType), not a hardcoded+// Engine_DORIS. On a StarRocks-only statement the two engines must disagree —+// doris rejects it (→ allQuery forced true, DDL wrongly routed through+// QueryContext), starrocks accepts it (→ correct allQuery=false).+func TestValidateSQLForEditor_EngineDispatch(t *testing.T) {+ // StarRocks generated column AS (expr): doris wants GENERATED ALWAYS AS.+ const ddl = "CREATE TABLE t (a INT, b INT AS (a + 1)) DUPLICATE KEY(a) DISTRIBUTED BY HASH(a)"++ _, srAllQuery, srErr := base.ValidateSQLForEditor(storepb.Engine_STARROCKS, ddl)+ require.NoError(t, srErr, "starrocks parser should accept StarRocks DDL")+ require.False(t, srAllQuery, "a CREATE TABLE is DDL, not a read-only query")++ _, _, dorisErr := base.ValidateSQLForEditor(storepb.Engine_DORIS, ddl)+ require.Error(t, dorisErr, "doris parser rejects StarRocks AS(expr) DDL — why d.dbType matters")+}diff --git a/backend/plugin/db/starrocks/starrocks.go b/backend/plugin/db/starrocks/starrocks.goindex d1884c0ea0..4a5a449ae9 100644--- a/backend/plugin/db/starrocks/starrocks.go+++ b/backend/plugin/db/starrocks/starrocks.go@@ -69,7 +69,7 @@ func (d *Driver) Open(_ context.Context, dbType storepb.Engine, connCfg db.Conneprotocol = "unix"}params := []string{"multiStatements=true", "maxAllowedPacket=0"}- if dbType == storepb.Engine_DORIS {+ if dbType == storepb.Engine_DORIS || dbType == storepb.Engine_STARROCKS {params = append(params, "interpolateParams=true")}if connCfg.DataSource.GetSshHost() != "" {@@ -276,7 +276,7 @@ func (d *Driver) executeInAutoCommitMode(ctx context.Context, statement string)// QueryConn queries a SQL statement in a given connection.func (d *Driver) QueryConn(ctx context.Context, conn *sql.Conn, statement string, queryContext db.QueryContext) ([]*v1pb.QueryResult, error) {- singleSQLs, err := base.SplitMultiSQL(storepb.Engine_DORIS, statement)+ singleSQLs, err := base.SplitMultiSQL(d.dbType, statement)if err != nil {return nil, err}@@ -301,7 +301,7 @@ func (d *Driver) QueryConn(ctx context.Context, conn *sql.Conn, statement string}sqlWithBytebaseAppComment := util.MySQLPrependBytebaseAppComment(statement)- _, allQuery, err := base.ValidateSQLForEditor(storepb.Engine_DORIS, statement)+ _, allQuery, err := base.ValidateSQLForEditor(d.dbType, statement)if err != nil {// TODO(d): need to make parser compatible.slog.Error("failed to validate sql", slog.String("statement", statement), log.BBError(err))diff --git a/backend/plugin/db/starrocks/sync.go b/backend/plugin/db/starrocks/sync.goindex 54479be48a..bcc15dcf5a 100644--- a/backend/plugin/db/starrocks/sync.go+++ b/backend/plugin/db/starrocks/sync.go@@ -22,19 +22,17 @@ const (autoIncrementSymbol = "AUTO_INCREMENT")-var (- systemDatabases = map[string]bool{- "information_schema": true,- "_statistics_": true,+// systemDatabaseExclusion returns the quoted, comma-joined system databases to+// exclude from instance discovery, per the driver's engine. StarRocks adds its+// read-only `sys` metadatabase (Doris has no sys), matching the parser-side+// system-database classification.+func (d *Driver) systemDatabaseExclusion() string {+ dbs := []string{"'information_schema'", "'_statistics_'"}+ if d.dbType == storepb.Engine_STARROCKS {+ dbs = append(dbs, "'sys'")}- systemDatabaseClause = func() string {- var l []string- for k := range systemDatabases {- l = append(l, fmt.Sprintf("'%s'", k))- }- return strings.Join(l, ", ")- }()-)+ return strings.Join(dbs, ", ")+}// SyncInstance syncs the instance.func (d *Driver) SyncInstance(ctx context.Context) (*db.InstanceMetadata, error) {@@ -57,7 +55,7 @@ func (d *Driver) SyncInstance(ctx context.Context) (*db.InstanceMetadata, error)}// Query db info- where := fmt.Sprintf("LOWER(SCHEMA_NAME) NOT IN (%s)", systemDatabaseClause)+ where := fmt.Sprintf("LOWER(SCHEMA_NAME) NOT IN (%s)", d.systemDatabaseExclusion())query := `SELECTSCHEMA_NAME,@@ -81,7 +79,7 @@ func (d *Driver) SyncInstance(ctx context.Context) (*db.InstanceMetadata, error)); err != nil {return nil, err}- if d.dbType == storepb.Engine_DORIS {+ if d.dbType == storepb.Engine_DORIS || d.dbType == storepb.Engine_STARROCKS {database.CharacterSet = ""database.Collation = ""}@@ -375,7 +373,7 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*storepb.DatabaseSchemaMetad}// "characterSet":"utf8\u0000", "collation":"utf8_general_ci\u0000".// ERROR: unsupported Unicode escape sequence (SQLSTATE 22P05).- if d.dbType == storepb.Engine_DORIS {+ if d.dbType == storepb.Engine_DORIS || d.dbType == storepb.Engine_STARROCKS {databaseMetadata.CharacterSet = ""databaseMetadata.Collation = ""}diff --git a/backend/plugin/db/starrocks/sync_systemdb_test.go b/backend/plugin/db/starrocks/sync_systemdb_test.gonew file mode 100644index 0000000000..c983501999--- /dev/null+++ b/backend/plugin/db/starrocks/sync_systemdb_test.go@@ -0,0 +1,24 @@+package starrocks++import (+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++// #20566 review (P2): SyncInstance's system-database exclusion must match the+// parser's per-engine system set — StarRocks's read-only `sys` metadatabase+// must be excluded so it isn't imported as a user database. Doris has no `sys`,+// so excluding it there would risk hiding a user db named sys (engine-aware).+func TestSystemDatabaseExclusion(t *testing.T) {+ sr := (&Driver{dbType: storepb.Engine_STARROCKS}).systemDatabaseExclusion()+ require.Contains(t, sr, "'sys'", "StarRocks sync must exclude the sys metadatabase")+ require.Contains(t, sr, "'information_schema'")+ require.Contains(t, sr, "'_statistics_'")++ doris := (&Driver{dbType: storepb.Engine_DORIS}).systemDatabaseExclusion()+ require.NotContains(t, doris, "'sys'", "Doris must not exclude sys (StarRocks-only)")+ require.Contains(t, doris, "'information_schema'")+}diff --git a/backend/plugin/parser/starrocks/query_span_extractor.go b/backend/plugin/parser/starrocks/query_span_extractor.goindex 04cffaf733..fc22c083df 100644--- a/backend/plugin/parser/starrocks/query_span_extractor.go+++ b/backend/plugin/parser/starrocks/query_span_extractor.go@@ -167,13 +167,14 @@ func isMixedQuery(m base.SourceColumnSet, ignoreCaseSensitive bool) (bool, bool)return !hasUser && hasSystem, false}-// systemDatabases contains Doris system databases-// Reference: https://doris.apache.org/docs/3.x/admin-manual/system-tables/overview+// systemDatabases contains StarRocks system databases. StarRocks exposes a+// read-only `sys` metadatabase and does not have Doris's `mysql` /+// `__internal_schema`.+// Reference: https://docs.starrocks.io/docs/administration/management/system_catalogs/sys/var systemDatabases = map[string]bool{"information_schema": true,- "mysql": true,- "__internal_schema": true,"_statistics_": true,+ "sys": true,}func isSystemResource(resource base.ColumnResource, ignoreCaseSensitive bool) bool {diff --git a/backend/plugin/parser/starrocks/system_database_test.go b/backend/plugin/parser/starrocks/system_database_test.gonew file mode 100644index 0000000000..9ff4ea6412--- /dev/null+++ b/backend/plugin/parser/starrocks/system_database_test.go@@ -0,0 +1,29 @@+package starrocks++import (+ "testing"++ "github.com/bytebase/bytebase/backend/plugin/parser/base"+)++// #20562 review (P2): the system-database set must be StarRocks-specific, not the+// copied Doris list. StarRocks has a read-only `sys` metadatabase (SHOW DATABASES+// confirms: information_schema, _statistics_, sys) and no `mysql`/`__internal_schema`.+func TestIsSystemResource_StarRocks(t *testing.T) {+ cases := []struct {+ database string+ want bool+ }{+ {"sys", true}, // StarRocks system metadatabase+ {"information_schema", true}, // shared+ {"_statistics_", true}, // statistics+ {"mysql", false}, // Doris-only, not a StarRocks system db+ {"__internal_schema", false}, // Doris-only+ {"my_user_db", false}, // user database+ }+ for _, c := range cases {+ if got := isSystemResource(base.ColumnResource{Database: c.database}, true); got != c.want {+ t.Errorf("isSystemResource(%q) = %v, want %v", c.database, got, c.want)+ }+ }+}diff --git a/backend/plugin/parser/starrocks/test-data/query_span_system_table.yaml b/backend/plugin/parser/starrocks/test-data/query_span_system_table.yamlindex c62bbf3758..165fd947d0 100644--- a/backend/plugin/parser/starrocks/test-data/query_span_system_table.yaml+++ b/backend/plugin/parser/starrocks/test-data/query_span_system_table.yaml@@ -40,8 +40,8 @@table: table_statisticscolumn: ""predicatecolumns: []-- description: Query mysql database- statement: SELECT * FROM mysql.user+- description: Query sys metadatabase (StarRocks system db; Doris has no sys, and StarRocks has no mysql/__internal_schema)+ statement: SELECT * FROM sys.grants_to_rolesdefaultDatabase: testdbmetadata: '{}'querySpan:@@ -49,23 +49,9 @@results: []sourcecolumns:- server: ""- database: mysql+ database: sysschema: ""- table: user- column: ""- predicatecolumns: []-- description: Query __internal_schema database- statement: SELECT * FROM __internal_schema.audit_log- defaultDatabase: testdb- metadata: '{}'- querySpan:- type: 3- results: []- sourcecolumns:- - server: ""- database: __internal_schema- schema: ""- table: audit_log+ table: grants_to_rolescolumn: ""predicatecolumns: []- description: Query user table