Skip to content

feat(sql_workbench): ODC workbench support for GoldenDB #610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
actiontech-bot wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(sql_workbench): ODC workbench support for GoldenDB #610

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e4e8ac
feat(sql_workbench): add GoldenDB datasource type mapping and support…
LordofAvernus May 8, 2026
f06611a
feat(sql_workbench): add DefaultSchema field to ODC datasource sync r…
LordofAvernus May 8, 2026
a7f7ec8
fix: AuditMiddleware bypass SQL audit for DB types unsupported by SQLE
LordofAvernus May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion internal/sql_workbench/client/sql_workbench_client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -978,9 +978,10 @@ type CreateDatasourceRequest struct {
JdbcURLParameters map[string]interface{} `json:"jdbcUrlParameters"`
Host string `json:"host"`
Port string `json:"port"`
DefaultSchema *string `json:"defaultSchema,omitempty"`
}

// UpdateDatasourceRequest 创建数据源请求结构
// UpdateDatasourceRequest 更新数据源请求结构
type UpdateDatasourceRequest struct {
Id int64 `json:"id"`
CreatorID *int64 `json:"creatorId"`
Expand All @@ -997,6 +998,7 @@ type UpdateDatasourceRequest struct {
JdbcURLParameters *map[string]interface{} `json:"jdbcUrlParameters"`
Host string `json:"host"`
Port string `json:"port"`
DefaultSchema *string `json:"defaultSchema,omitempty"`
}

// DataSourceStatus 数据源状态结构
Expand Down
30 changes: 29 additions & 1 deletion internal/sql_workbench/service/sql_workbench_service.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,6 +839,7 @@ type datasourceBaseInfo struct {
Port string
ServiceName *string
EnvironmentID int64
DefaultSchema *string
}

// buildDatasourceBaseInfo 构建数据源基础信息
Expand Down Expand Up @@ -885,6 +886,7 @@ func (sqlWorkbenchService *SqlWorkbenchService) buildCreateDatasourceRequest(ctx
ServiceName: baseInfo.ServiceName,
SSLConfig: client.SSLConfig{Enabled: false},
EnvironmentID: baseInfo.EnvironmentID,
DefaultSchema: baseInfo.DefaultSchema,
}, nil
}

Expand All @@ -905,6 +907,7 @@ func (sqlWorkbenchService *SqlWorkbenchService) buildUpdateDatasourceRequest(ctx
ServiceName: baseInfo.ServiceName,
SSLConfig: client.SSLConfig{Enabled: false},
EnvironmentID: baseInfo.EnvironmentID,
DefaultSchema: baseInfo.DefaultSchema,
}, nil
}

Expand All @@ -930,13 +933,15 @@ func (sqlWorkbenchService *SqlWorkbenchService) convertDBType(dmsDBType string)
return "DM"
case "TiDB":
return "TIDB"
case "GoldenDB":
return "MYSQL"
default:
return dmsDBType
}
}

func (sqlWorkbenchService *SqlWorkbenchService) SupportDBType(dbType pkgConst.DBType) bool {
return dbType == pkgConst.DBTypeMySQL || dbType == pkgConst.DBTypeOracle || dbType == pkgConst.DBTypeOceanBaseMySQL || dbType == pkgConst.DBTypeDM || dbType == pkgConst.DBTypeTiDB
return dbType == pkgConst.DBTypeMySQL || dbType == pkgConst.DBTypeOracle || dbType == pkgConst.DBTypeOceanBaseMySQL || dbType == pkgConst.DBTypeDM || dbType == pkgConst.DBTypeTiDB || dbType == pkgConst.DBTypeGoldenDB
}

// buildDatabaseUser 当是ob-mysql时需要给账号管理的账号附加租户名集群名等字符: root@oms_mysql#oms_resource_4250
Expand Down Expand Up @@ -1070,6 +1075,12 @@ func (sqlWorkbenchService *SqlWorkbenchService) AuditMiddleware() echo.Middlewar
return errors.New(locale.Bundle.LocalizeMsgByCtx(c.Request().Context(), locale.SqlWorkbenchAuditGetDBServiceErr))
}

// 对 SQLE 不支持审核的数据库类型（如 GoldenDB）直接放行，不做审核拦截
if !sqlWorkbenchService.isSQLAuditSupportedDBType(dbService.DBType) {
sqlWorkbenchService.log.Infof("SQL audit not supported for db type %s (DBService: %s), bypassing audit", dbService.DBType, dmsDBServiceID)
return next(c)
}

// 检查是否启用 SQL 审核
if !sqlWorkbenchService.isEnableSQLAudit(dbService) {
sqlWorkbenchService.log.Debugf("SQL audit is not enabled for DBService: %s", dmsDBServiceID)
Expand Down Expand Up @@ -1225,6 +1236,23 @@ func (sqlWorkbenchService *SqlWorkbenchService) isEnableSQLAudit(dbService *biz.
return dbService.SQLEConfig.AuditEnabled && dbService.SQLEConfig.SQLQueryConfig.AuditEnabled
}

// isSQLAuditSupportedDBType 判断当前数据源类型是否被 SQLE 审核插件支持。
// SQLE 仅对有对应审核插件的数据库类型提供审核能力；对于不在此列表中的类型
// （如 GoldenDB、TBase、DB2 等），AuditMiddleware 应跳过审核直接放行。
func (sqlWorkbenchService *SqlWorkbenchService) isSQLAuditSupportedDBType(dbType string) bool {
supportedTypes := map[string]struct{}{
string(pkgConst.DBTypeMySQL): {},
string(pkgConst.DBTypeOracle): {},
string(pkgConst.DBTypeOceanBaseMySQL): {},
string(pkgConst.DBTypeTiDB): {},
string(pkgConst.DBTypePostgreSQL): {},
string(pkgConst.DBTypeSQLServer): {},
string(pkgConst.DBTypeDM): {},
}
_, ok := supportedTypes[dbType]
return ok
}

// callSQLEAudit 调用 SQLE 直接审核接口
func (sqlWorkbenchService *SqlWorkbenchService) callSQLEAudit(ctx context.Context, sql string, dbService *biz.DBService) (*cloudbeaver.AuditSQLReply, error) {
// 获取 SQLE 服务地址
Expand Down
32 changes: 32 additions & 0 deletions internal/sql_workbench/service/sql_workbench_service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ func Test_convertDBType(t *testing.T) {
"OB Oracle": {input: "OceanBase For Oracle", expected: "OB_ORACLE"},
"OB MySQL": {input: "OceanBase For MySQL", expected: "OB_MYSQL"},
"TiDB": {input: "TiDB", expected: "TIDB"},
"GoldenDB": {input: "GoldenDB", expected: "MYSQL"},
"Unknown passthrough": {input: "UnknownDB", expected: "UnknownDB"},
}
for name, tc := range cases {
Expand All @@ -32,6 +33,36 @@ func Test_convertDBType(t *testing.T) {
}
}

func Test_isSQLAuditSupportedDBType(t *testing.T) {
svc := &SqlWorkbenchService{}
cases := map[string]struct {
input string
expected bool
}{
"MySQL supported": {input: string(pkgConst.DBTypeMySQL), expected: true},
"Oracle supported": {input: string(pkgConst.DBTypeOracle), expected: true},
"OB MySQL supported": {input: string(pkgConst.DBTypeOceanBaseMySQL), expected: true},
"TiDB supported": {input: string(pkgConst.DBTypeTiDB), expected: true},
"PostgreSQL supported": {input: string(pkgConst.DBTypePostgreSQL), expected: true},
"SQL Server supported": {input: string(pkgConst.DBTypeSQLServer), expected: true},
"DM supported": {input: string(pkgConst.DBTypeDM), expected: true},
"GoldenDB not supported": {input: string(pkgConst.DBTypeGoldenDB), expected: false},
"TBase not supported": {input: string(pkgConst.DBTypeTBase), expected: false},
"DB2 not supported": {input: string(pkgConst.DBTypeDB2), expected: false},
"Hive not supported": {input: string(pkgConst.DBTypeHive), expected: false},
"GaussDB not supported": {input: string(pkgConst.DBTypeGaussDB), expected: false},
"Unknown not supported": {input: "UnknownDB", expected: false},
}
for name, tc := range cases {
t.Run(name, func(t *testing.T) {
got := svc.isSQLAuditSupportedDBType(tc.input)
if got != tc.expected {
t.Errorf("isSQLAuditSupportedDBType(%q) = %v, want %v", tc.input, got, tc.expected)
}
})
}
}

func Test_SupportDBType(t *testing.T) {
svc := &SqlWorkbenchService{}
cases := map[string]struct {
Expand All @@ -43,6 +74,7 @@ func Test_SupportDBType(t *testing.T) {
"Oracle supported": {input: pkgConst.DBTypeOracle, expected: true},
"OB MySQL supported": {input: pkgConst.DBTypeOceanBaseMySQL, expected: true},
"TiDB supported": {input: pkgConst.DBTypeTiDB, expected: true},
"GoldenDB supported": {input: pkgConst.DBTypeGoldenDB, expected: true},
"PostgreSQL unsupported": {input: pkgConst.DBTypePostgreSQL, expected: false},
"SQL Server unsupported": {input: pkgConst.DBTypeSQLServer, expected: false},
}
Expand Down