Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
feat(oracle): sync private and public synonyms (#21713)
rebeliced1995abf8c02
diff --git a/backend/plugin/db/oracle/sync.go b/backend/plugin/db/oracle/sync.goindex eb6a9b447e..f8c65f097e 100644--- a/backend/plugin/db/oracle/sync.go+++ b/backend/plugin/db/oracle/sync.go@@ -130,6 +130,14 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMeif err != nil {return nil, errors.Wrapf(err, "failed to get materialized views from database %q", d.databaseName)}+ synonyms, err := getSynonyms(txn, d.databaseName)+ if err != nil {+ return nil, errors.Wrapf(err, "failed to get synonyms from database %q", d.databaseName)+ }+ publicSynonyms, err := getSynonyms(txn, publicSchema)+ if err != nil {+ return nil, errors.Wrapf(err, "failed to get public synonyms")+ }if err := txn.Commit(); err != nil {return nil, err@@ -139,6 +147,7 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMeName: d.databaseName,ServiceName: d.serviceName,LinkedDatabases: dbLinks,+ PublicSynonyms: publicSynonyms,}databaseMetadata.Schemas = append(databaseMetadata.Schemas, &metadatapb.SchemaMetadata{Name: "",@@ -149,6 +158,7 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMeFunctions: functions,Procedures: procedures,Packages: packages,+ Synonyms: synonyms,})// Deep-sanitize every string field (names, definitions, defaults, …), not// just comments: the go-ora driver returns wholly-unconverted raw bytes@@ -159,6 +169,41 @@ func (d *Driver) SyncDBSchema(ctx context.Context) (*metadatapb.DatabaseSchemaMereturn databaseMetadata, nil}+// publicSchema owns the public synonyms. No user can take its name (ORA-01920).+const publicSchema = "PUBLIC"++func getSynonyms(txn *sql.Tx, owner string) ([]*metadatapb.SynonymMetadata, error) {+ query := `+ SELECT SYNONYM_NAME, TABLE_OWNER, TABLE_NAME, DB_LINK+ FROM ALL_SYNONYMS+ WHERE OWNER = :1+ ORDER BY SYNONYM_NAME`+ rows, err := txn.Query(query, owner)+ if err != nil {+ return nil, util.FormatErrorWithQuery(err, query)+ }+ defer rows.Close()++ var synonyms []*metadatapb.SynonymMetadata+ for rows.Next() {+ var name string+ var targetSchema, targetName, targetDBLink sql.NullString+ if err := rows.Scan(&name, &targetSchema, &targetName, &targetDBLink); err != nil {+ return nil, err+ }+ synonyms = append(synonyms, &metadatapb.SynonymMetadata{+ Name: name,+ TargetSchema: targetSchema.String,+ TargetName: targetName.String,+ TargetDbLink: targetDBLink.String,+ })+ }+ if err := rows.Err(); err != nil {+ return nil, util.FormatErrorWithQuery(err, query)+ }+ return synonyms, nil+}+func getDBLinks(txn *sql.Tx) ([]*metadatapb.LinkedDatabaseMetadata, error) {query := `SELECT DB_LINK, HOST, USERNAMEdiff --git a/backend/plugin/db/oracle/sync_oracle_test.go b/backend/plugin/db/oracle/sync_oracle_test.goindex d8ad2f4006..f83b78b6f4 100644--- a/backend/plugin/db/oracle/sync_oracle_test.go+++ b/backend/plugin/db/oracle/sync_oracle_test.go@@ -9,7 +9,9 @@ import ("time"metadatapb "github.com/bytebase/omni/metadata"+ "github.com/google/go-cmp/cmp""github.com/stretchr/testify/require"+ "google.golang.org/protobuf/testing/protocmp""github.com/bytebase/bytebase/backend/common/testcontainer"storepb "github.com/bytebase/bytebase/backend/generated-go/store"@@ -214,3 +216,36 @@ func TestSyncLeavesOutTriggersOnOtherSchemasTables(t *testing.T) {synced := syncedSchema(ctx, t, driver)require.Equal(t, []string{"ON_OWN"}, names(tableByName(t, synced, "T").Triggers))}++func TestSyncListsSynonyms(t *testing.T) {+ t.Parallel()+ ctx := syncTestContext(t)+ driver, admin, s := newSyncTarget(ctx, t)+ _, other := testcontainer.NewOracleSchema(t)+ public := s + "_PUB"+ execAll(ctx, t, admin,+ fmt.Sprintf(`CREATE TABLE %s.T (A NUMBER)`, s),+ fmt.Sprintf(`CREATE TABLE %s.OT (A NUMBER)`, other),+ fmt.Sprintf(`CREATE SYNONYM %[1]s.S_OWN FOR %[1]s.T`, s),+ fmt.Sprintf(`CREATE SYNONYM %s.S_OTHER FOR %s.OT`, s, other),+ // ALL_SYNONYMS leaves out a synonym whose object does not exist.+ fmt.Sprintf(`CREATE SYNONYM %[1]s.S_GONE FOR %[1]s.NOSUCH`, s),+ fmt.Sprintf(`CREATE PUBLIC SYNONYM %s FOR %s.T`, public, s),+ )+ t.Cleanup(func() { _, _ = admin.ExecContext(context.Background(), "DROP PUBLIC SYNONYM "+public) })++ metadata, err := driver.SyncDBSchema(ctx)+ require.NoError(t, err)+ require.Len(t, metadata.Schemas, 1)+ require.Empty(t, cmp.Diff([]*metadatapb.SynonymMetadata{+ {Name: "S_OTHER", TargetSchema: other, TargetName: "OT"},+ {Name: "S_OWN", TargetSchema: s, TargetName: "T"},+ }, metadata.Schemas[0].Synonyms, protocmp.Transform()))++ byName := map[string]*metadatapb.SynonymMetadata{}+ for _, synonym := range metadata.PublicSynonyms {+ byName[synonym.Name] = synonym+ }+ require.Empty(t, cmp.Diff(&metadatapb.SynonymMetadata{Name: public, TargetSchema: s, TargetName: "T"}, byName[public], protocmp.Transform()))+ require.Empty(t, cmp.Diff(&metadatapb.SynonymMetadata{Name: "DUAL", TargetSchema: "SYS", TargetName: "DUAL"}, byName["DUAL"], protocmp.Transform()))+}diff --git a/go.mod b/go.modindex cfa6e62c89..6bf54bf70b 100644--- a/go.mod+++ b/go.mod@@ -36,7 +36,7 @@ require (github.com/bmatcuk/doublestar/v4 v4.10.0github.com/bytebase/gomongo v0.0.0-20260730033313-67ba6e249735github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0- github.com/bytebase/omni v0.0.0-20261030060306-9f7b65d360fd+ github.com/bytebase/omni v0.0.0-20261030065427-5fe94f228ab4github.com/caarlos0/env/v11 v11.4.1github.com/cenkalti/backoff/v7 v7.0.0github.com/cockroachdb/cockroach-go/v2 v2.4.3diff --git a/go.sum b/go.sumindex ca3ccc7f01..6b9cb86274 100644--- a/go.sum+++ b/go.sum@@ -252,8 +252,8 @@ github.com/bytebase/gomongo v0.0.0-20260730033313-67ba6e249735 h1:v8y6mXeHmYVsdMgithub.com/bytebase/gomongo v0.0.0-20260730033313-67ba6e249735/go.mod h1:vTHjcvfn8Pmf65WjnV1ytTCYyC7xNhFjrniv4YWvtA8=github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0 h1:bJ8NSf2K+pccl5m/wuu97fiYjDwpJH6IzURAq/3XA2U=github.com/bytebase/lsp-protocol v0.0.0-20250324071136-1586d0c10ff0/go.mod h1:BEWMfiZtqshdmulKJcIsWb45MUaEvDO4CROcgi8dfFg=-github.com/bytebase/omni v0.0.0-20261030060306-9f7b65d360fd h1:yg7l+EYm9Yw2fUNGORdb0FJY8KtIEpQdJ+1JFayeOqc=-github.com/bytebase/omni v0.0.0-20261030060306-9f7b65d360fd/go.mod h1:9XZE1hqtvr09Oc+DdLu1/yCb8MDcoy/EPdA4AONDHlE=+github.com/bytebase/omni v0.0.0-20261030065427-5fe94f228ab4 h1:e03DJwm3avZG4N7xsnKkkD+qZgraAH0I+04r8c7HIWU=+github.com/bytebase/omni v0.0.0-20261030065427-5fe94f228ab4/go.mod h1:9XZE1hqtvr09Oc+DdLu1/yCb8MDcoy/EPdA4AONDHlE=github.com/bytebase/pgx/v5 v5.0.0-20250212161523-96ff8aed8767 h1:YuR5G3LcxpO5ScSTA+Kdirxg9RW4TRc/v1t7N2Hfmbw=github.com/bytebase/pgx/v5 v5.0.0-20250212161523-96ff8aed8767/go.mod h1:ncY89UGWxg82EykZUwSpUKEfccBGGYq1xjrOpsbsfGQ=github.com/bytebase/pkcs8 v0.0.0-20240612095628-fcd0a7484c94 h1:6PNsuNmSqCuR8Z616uQLzDIvujWCFsKzeVc3ECmVubk=