Skip to content

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

refactor(api): localize parser engine conversion (#21507)

p0ny142df19c6a10
diff --git a/backend/api/v1/database_service.go b/backend/api/v1/database_service.go
index db5c47de78..6a884b5bd5 100644
--- a/backend/api/v1/database_service.go
+++ b/backend/api/v1/database_service.go
@@ -1245,7 +1245,26 @@ func (s *DatabaseService) getParserEngine(ctx context.Context, request *v1pb.Dif
if err != nil {
return storepb.Engine_ENGINE_UNSPECIFIED, err
}
- return common.ConvertToParserEngine(rawEngine)
+ return convertToParserEngine(rawEngine)
+}
+
+func convertToParserEngine(e storepb.Engine) (storepb.Engine, error) {
+ switch e {
+ case storepb.Engine_POSTGRES:
+ return storepb.Engine_POSTGRES, nil
+ case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE:
+ return storepb.Engine_MYSQL, nil
+ case storepb.Engine_TIDB:
+ return storepb.Engine_TIDB, nil
+ case storepb.Engine_ORACLE:
+ return storepb.Engine_ORACLE, nil
+ case storepb.Engine_MSSQL:
+ return storepb.Engine_MSSQL, nil
+ case storepb.Engine_COCKROACHDB:
+ return storepb.Engine_COCKROACHDB, nil
+ default:
+ return storepb.Engine_ENGINE_UNSPECIFIED, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid engine type %v", e))
+ }
}
func (s *DatabaseService) convertToDatabase(ctx context.Context, database *store.DatabaseMessage) (*v1pb.Database, error) {
diff --git a/backend/common/engine.go b/backend/common/engine.go
index 09870374f4..7e921f0dcf 100644
--- a/backend/common/engine.go
+++ b/backend/common/engine.go
@@ -2,9 +2,6 @@
package common
import (
- "connectrpc.com/connect"
- "github.com/pkg/errors"
-
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
)
@@ -502,22 +499,3 @@ func GetDefaultTransactionMode() TransactionMode {
// All engines default to "on" for safety and backward compatibility
return TransactionModeOn
}
-
-func ConvertToParserEngine(e storepb.Engine) (storepb.Engine, error) {
- switch e {
- case storepb.Engine_POSTGRES:
- return storepb.Engine_POSTGRES, nil
- case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_OCEANBASE:
- return storepb.Engine_MYSQL, nil
- case storepb.Engine_TIDB:
- return storepb.Engine_TIDB, nil
- case storepb.Engine_ORACLE:
- return storepb.Engine_ORACLE, nil
- case storepb.Engine_MSSQL:
- return storepb.Engine_MSSQL, nil
- case storepb.Engine_COCKROACHDB:
- return storepb.Engine_COCKROACHDB, nil
- default:
- return storepb.Engine_ENGINE_UNSPECIFIED, connect.NewError(connect.CodeInvalidArgument, errors.Errorf("invalid engine type %v", e))
- }
-}
diff --git a/docs/backend-common-audit.md b/docs/backend-common-audit.md
index efbdaaede9..78096aaa9d 100644
--- a/docs/backend-common-audit.md
+++ b/docs/backend-common-audit.md
@@ -6,7 +6,9 @@ truncation, private store credential helpers, and private v1 audit callbacks.
The second migration moves the PostgreSQL socket-directory helper to
`resources/postgres`, prefix matching to a private server helper, ANTLR line
conversion to `plugin/parser/base`, and TiDB error-position conversion to a
-private TiDB parser helper. The remaining entries are proposals.
+private TiDB parser helper. A subsequent migration moves the Connect-specific
+parser-engine conversion into a private v1 helper. The remaining entries are
+proposals.
The root package mixes unrelated ownership: resource names, identity, request
context, audit transport, policy expressions, SQL execution, and generic helpers.
@@ -34,7 +36,7 @@ necessarily existing files or packages.
| `HasPrefixes` | Private helper in `server` | Only `server_frontend_routes.go` calls it. |
| Live position conversions in `common/position.go` | `plugin/parser/base/position.go`; TiDB-only conversion local to `plugin/parser/tidb` | Parser base already owns position mapping. Advisor implementations consume the ANTLR line conversion. |
| Transaction types and default mode in `common/engine.go` | `plugin/parser/base/transaction_mode.go` | This file already parses directives and converts isolation levels; drivers consume the result. Avoid putting types in `plugin/db` and making parser base depend on drivers. |
-| `ConvertToParserEngine` | Private helper in `api/v1` initially | Only v1 calls it, and it returns a Connect error. A parser-owned version should return a transport-independent error. |
+| `ConvertToParserEngine` (completed) | Private helper in `api/v1` | Only v1 calls it, and it returns a Connect error. The move preserves the mapping and error behavior. |
| Audit callback keys, setters, getters, `PermissionDeniedError` | Private helpers in `api/v1` | These coordinate v1 interceptors and handlers; no production callers outside v1 were found. |
| `GetQueryExportFactors` and its traversal | Private helpers in `component/review` | The only production caller is review evaluation. It should consume the shared IAM expression definitions described below. |
| `SanitizeUTF8Message` and reflection traversal | Private helpers in `plugin/db/oracle` | Only Oracle metadata sync calls it. Keep string sanitization shared because v1 uses it too. |