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: support MariaDB DML rollback (#20278)
p0nya3fff6355a10
diff --git a/backend/common/engine.go b/backend/common/engine.goindex aa0f8b81a5..eef98e6e74 100644--- a/backend/common/engine.go+++ b/backend/common/engine.go@@ -241,6 +241,7 @@ func EngineSupportPriorBackup(e storepb.Engine) bool {switch e {casestorepb.Engine_MYSQL,+ storepb.Engine_MARIADB,storepb.Engine_TIDB,storepb.Engine_MSSQL,storepb.Engine_ORACLE,@@ -257,7 +258,6 @@ func EngineSupportPriorBackup(e storepb.Engine) bool {storepb.Engine_SPANNER,storepb.Engine_BIGQUERY,storepb.Engine_REDSHIFT,- storepb.Engine_MARIADB,storepb.Engine_OCEANBASE,storepb.Engine_STARROCKS,storepb.Engine_HIVE,@@ -393,6 +393,7 @@ func BackupDatabaseNameOfEngine(e storepb.Engine) string {switch e {casestorepb.Engine_MYSQL,+ storepb.Engine_MARIADB,storepb.Engine_TIDB,storepb.Engine_MSSQL,storepb.Engine_POSTGRES:@@ -411,7 +412,6 @@ func BackupDatabaseNameOfEngine(e storepb.Engine) string {storepb.Engine_SPANNER,storepb.Engine_BIGQUERY,storepb.Engine_REDSHIFT,- storepb.Engine_MARIADB,storepb.Engine_OCEANBASE,storepb.Engine_STARROCKS,storepb.Engine_HIVE,diff --git a/backend/common/engine_test.go b/backend/common/engine_test.gonew file mode 100644index 0000000000..8342ccc293--- /dev/null+++ b/backend/common/engine_test.go@@ -0,0 +1,17 @@+package common++import (+ "testing"++ "github.com/stretchr/testify/require"++ storepb "github.com/bytebase/bytebase/backend/generated-go/store"+)++func TestEngineSupportPriorBackupMariaDB(t *testing.T) {+ require.True(t, EngineSupportPriorBackup(storepb.Engine_MARIADB))+}++func TestBackupDatabaseNameOfEngineMariaDB(t *testing.T) {+ require.Equal(t, "bbdataarchive", BackupDatabaseNameOfEngine(storepb.Engine_MARIADB))+}diff --git a/backend/plugin/advisor/builtin_rules.go b/backend/plugin/advisor/builtin_rules.goindex 4a7e62d090..702df4098f 100644--- a/backend/plugin/advisor/builtin_rules.go+++ b/backend/plugin/advisor/builtin_rules.go@@ -6,7 +6,7 @@ func GetBuiltinRules(engine storepb.Engine) []*storepb.SQLReviewRule {var rules []*storepb.SQLReviewRuleswitch engine {- case storepb.Engine_MYSQL, storepb.Engine_POSTGRES, storepb.Engine_TIDB, storepb.Engine_MSSQL, storepb.Engine_ORACLE:+ case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_POSTGRES, storepb.Engine_TIDB, storepb.Engine_MSSQL, storepb.Engine_ORACLE:rules = append(rules, &storepb.SQLReviewRule{Type: storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK,Level: storepb.SQLReviewRule_WARNING,diff --git a/backend/plugin/advisor/mysql/mysql_rules_test.go b/backend/plugin/advisor/mysql/mysql_rules_test.goindex 3f9ed385b7..d2bc639dcd 100644--- a/backend/plugin/advisor/mysql/mysql_rules_test.go+++ b/backend/plugin/advisor/mysql/mysql_rules_test.go@@ -1,8 +1,12 @@package mysqlimport (+ "context""testing"+ "github.com/stretchr/testify/require"++ "github.com/bytebase/bytebase/backend/component/sheet"storepb "github.com/bytebase/bytebase/backend/generated-go/store""github.com/bytebase/bytebase/backend/plugin/advisor")@@ -86,3 +90,22 @@ func TestMySQLRules(t *testing.T) {advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_MYSQL, false /* record */)}}++func TestMariaDBPriorBackupCheckAdvisor(t *testing.T) {+ sm := sheet.NewManager()++ adviceList, err := advisor.SQLReviewCheck(context.Background(), sm, "CREATE TABLE t(id INT);\nUPDATE test SET c1 = 1 WHERE b1 = 1;", nil, advisor.Context{+ DBType: storepb.Engine_MARIADB,+ DBSchema: advisor.MockMySQLDatabase,+ EnablePriorBackup: true,+ InstanceID: "instance",+ ListDatabaseNamesFunc: func(context.Context, string) ([]string, error) {+ return []string{"bbdataarchive"}, nil+ },+ })++ require.NoError(t, err)+ require.NotEmpty(t, adviceList)+ require.Equal(t, storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK.String(), adviceList[0].Title)+ require.Contains(t, adviceList[0].Content, "mixed DDL and DML")+}diff --git a/backend/plugin/advisor/mysql/rule_builtin_prior_backup_check.go b/backend/plugin/advisor/mysql/rule_builtin_prior_backup_check.goindex 3a0a8e3d3f..fb1313b73a 100644--- a/backend/plugin/advisor/mysql/rule_builtin_prior_backup_check.go+++ b/backend/plugin/advisor/mysql/rule_builtin_prior_backup_check.go@@ -21,6 +21,7 @@ var (func init() {advisor.Register(storepb.Engine_MYSQL, storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK, &StatementPriorBackupCheckAdvisor{})+ advisor.Register(storepb.Engine_MARIADB, storepb.SQLReviewRule_BUILTIN_PRIOR_BACKUP_CHECK, &StatementPriorBackupCheckAdvisor{})}type StatementPriorBackupCheckAdvisor struct {diff --git a/backend/plugin/parser/mysql/backup.go b/backend/plugin/parser/mysql/backup.goindex 5fa119d984..31f01cc264 100644--- a/backend/plugin/parser/mysql/backup.go+++ b/backend/plugin/parser/mysql/backup.go@@ -19,6 +19,7 @@ import (func init() {base.RegisterTransformDMLToSelect(storepb.Engine_MYSQL, TransformDMLToSelect)+ base.RegisterTransformDMLToSelect(storepb.Engine_MARIADB, TransformDMLToSelect)}const (diff --git a/backend/plugin/parser/mysql/backup_test.go b/backend/plugin/parser/mysql/backup_test.goindex ebe3980e1e..5d46832dac 100644--- a/backend/plugin/parser/mysql/backup_test.go+++ b/backend/plugin/parser/mysql/backup_test.go@@ -76,6 +76,22 @@ func TestBackup(t *testing.T) {}}+func TestMariaDBTransformDMLToSelectRegistration(t *testing.T) {+ getter, lister := buildFixedMockDatabaseMetadataGetterAndLister()++ result, err := base.TransformDMLToSelect(context.Background(), store.Engine_MARIADB, base.TransformContext{+ GetDatabaseMetadataFunc: getter,+ ListDatabaseNamesFunc: lister,+ IsCaseSensitive: false,+ }, "DELETE FROM test WHERE b1 = 1;", "db", "backupDB", "_rollback")++ require.NoError(t, err)+ require.Len(t, result, 1)+ require.Equal(t, "test", result[0].SourceTableName)+ require.Equal(t, "_rollback_test_db", result[0].TargetTableName)+ require.Contains(t, result[0].Statement, "CREATE TABLE `backupDB`.`_rollback_test_db` LIKE `db`.`test`;")+}+func buildFixedMockDatabaseMetadataGetterAndLister() (base.GetDatabaseMetadataFunc, base.ListDatabaseNamesFunc) {schemaMetadata := []*store.SchemaMetadata{{diff --git a/backend/plugin/parser/mysql/restore.go b/backend/plugin/parser/mysql/restore.goindex 5217a6d484..28031a1b0c 100644--- a/backend/plugin/parser/mysql/restore.go+++ b/backend/plugin/parser/mysql/restore.go@@ -20,6 +20,7 @@ const (func init() {base.RegisterGenerateRestoreSQL(storepb.Engine_MYSQL, GenerateRestoreSQL)+ base.RegisterGenerateRestoreSQL(storepb.Engine_MARIADB, GenerateRestoreSQL)}func GenerateRestoreSQL(ctx context.Context, rCtx base.RestoreContext, statement string, backupItem *storepb.PriorBackupDetail_Item) (string, error) {diff --git a/backend/plugin/parser/mysql/restore_test.go b/backend/plugin/parser/mysql/restore_test.goindex d0cad91d39..a760c50339 100644--- a/backend/plugin/parser/mysql/restore_test.go+++ b/backend/plugin/parser/mysql/restore_test.go@@ -79,3 +79,33 @@ func TestRestore(t *testing.T) {yamltest.Record(t, filepath, tests)}}++func TestMariaDBGenerateRestoreSQLRegistration(t *testing.T) {+ getter, lister := buildFixedMockDatabaseMetadataGetterAndLister()++ result, err := base.GenerateRestoreSQL(context.Background(), store.Engine_MARIADB, base.RestoreContext{+ GetDatabaseMetadataFunc: getter,+ ListDatabaseNamesFunc: lister,+ IsCaseSensitive: false,+ }, "DELETE FROM test WHERE b1 = 1;", &store.PriorBackupDetail_Item{+ SourceTable: &store.PriorBackupDetail_Item_Table{+ Database: "instances/i1/databases/db",+ Table: "test",+ },+ TargetTable: &store.PriorBackupDetail_Item_Table{+ Database: "instances/i1/databases/bbarchive",+ Table: "prefix_test",+ },+ StartPosition: &store.Position{+ Line: 0,+ Column: 0,+ },+ EndPosition: &store.Position{+ Line: math.MaxInt32,+ Column: 0,+ },+ })++ require.NoError(t, err)+ require.Equal(t, "/*\nOriginal SQL:\nDELETE FROM test WHERE b1 = 1;\n*/\nINSERT INTO `db`.`test` SELECT * FROM `bbarchive`.`prefix_test`;", result)+}diff --git a/backend/runner/schemasync/syncer.go b/backend/runner/schemasync/syncer.goindex 07dadef6df..6f60a97094 100644--- a/backend/runner/schemasync/syncer.go+++ b/backend/runner/schemasync/syncer.go@@ -489,7 +489,7 @@ func (s *Syncer) databaseBackupAvailable(ctx context.Context, instance *store.Inreturn true}}- case storepb.Engine_MYSQL, storepb.Engine_MSSQL, storepb.Engine_TIDB:+ case storepb.Engine_MYSQL, storepb.Engine_MARIADB, storepb.Engine_MSSQL, storepb.Engine_TIDB, storepb.Engine_ORACLE:dbName := common.BackupDatabaseNameOfEngine(instance.Metadata.GetEngine())backupDB, err := s.store.GetDatabase(ctx, &store.FindDatabaseMessage{InstanceID: &instance.ResourceID,@@ -500,17 +500,6 @@ func (s *Syncer) databaseBackupAvailable(ctx context.Context, instance *store.Inreturn false}return backupDB != nil- case storepb.Engine_ORACLE:- dbName := common.BackupDatabaseNameOfEngine(storepb.Engine_ORACLE)- backupDB, err := s.store.GetDatabase(ctx, &store.FindDatabaseMessage{- InstanceID: &instance.ResourceID,- DatabaseName: &dbName,- })- if err != nil {- slog.Debug("Failed to get backup database", "err", err)- return false- }- return backupDB != nildefault:// Unsupported database engine for backupslog.Debug("Unsupported database engine for backup", "engine", instance.Metadata.GetEngine())diff --git a/backend/runner/taskrun/database_migrate_executor.go b/backend/runner/taskrun/database_migrate_executor.goindex 6738dcd4ad..913105f9c5 100644--- a/backend/runner/taskrun/database_migrate_executor.go+++ b/backend/runner/taskrun/database_migrate_executor.go@@ -842,12 +842,8 @@ func (exec *DatabaseMigrateExecutor) backupData(return nil, errors.Wrapf(err, "failed to execute backup statement %q", backupStatement)}switch instance.Metadata.GetEngine() {- case storepb.Engine_TIDB:- if _, err := driver.Execute(driverCtx, fmt.Sprintf("ALTER TABLE `%s`.`%s` COMMENT = '%s, source table (%s, %s)'", backupDatabaseName, statement.TargetTableName, bbSource, database.DatabaseName, statement.SourceTableName), db.ExecuteOptions{}); err != nil {- return nil, errors.Wrap(err, "failed to set table comment")- }- case storepb.Engine_MYSQL:- if _, err := driver.Execute(driverCtx, fmt.Sprintf("ALTER TABLE `%s`.`%s` COMMENT = '%s, source table (%s, %s)'", backupDatabaseName, statement.TargetTableName, bbSource, database.DatabaseName, statement.SourceTableName), db.ExecuteOptions{}); err != nil {+ case storepb.Engine_TIDB, storepb.Engine_MYSQL, storepb.Engine_MARIADB:+ if _, err := driver.Execute(driverCtx, buildMySQLFamilyBackupTableCommentStatement(backupDatabaseName, statement.TargetTableName, bbSource, database.DatabaseName, statement.SourceTableName), db.ExecuteOptions{}); err != nil {return nil, errors.Wrap(err, "failed to set table comment")}case storepb.Engine_MSSQL:@@ -908,6 +904,10 @@ func (exec *DatabaseMigrateExecutor) backupData(return priorBackupDetail, nil}+func buildMySQLFamilyBackupTableCommentStatement(backupDatabaseName, targetTableName, bbSource, databaseName, sourceTableName string) string {+ return fmt.Sprintf("ALTER TABLE `%s`.`%s` COMMENT = '%s, source table (%s, %s)'", backupDatabaseName, targetTableName, bbSource, databaseName, sourceTableName)+}+func buildGetDatabaseMetadataFunc(storeInstance *store.Store, workspace string) parserbase.GetDatabaseMetadataFunc {return func(ctx context.Context, instanceID, databaseName string) (string, *model.DatabaseMetadata, error) {database, err := storeInstance.GetDatabase(ctx, &store.FindDatabaseMessage{diff --git a/backend/runner/taskrun/database_migrate_executor_test.go b/backend/runner/taskrun/database_migrate_executor_test.goindex 8529e03115..e71713f694 100644--- a/backend/runner/taskrun/database_migrate_executor_test.go+++ b/backend/runner/taskrun/database_migrate_executor_test.go@@ -290,3 +290,11 @@ func TestGetPrependStatements(t *testing.T) {})}}++func TestBuildMySQLFamilyBackupTableCommentStatement(t *testing.T) {+ require.Equal(+ t,+ "ALTER TABLE `bbdataarchive`.`_rollback_test_db` COMMENT = 'task 101, source table (app, test)'",+ buildMySQLFamilyBackupTableCommentStatement("bbdataarchive", "_rollback_test_db", "task 101", "app", "test"),+ )+}diff --git a/frontend/src/react/pages/project/issue-detail/utils/databaseChange.test.ts b/frontend/src/react/pages/project/issue-detail/utils/databaseChange.test.tsnew file mode 100644index 0000000000..f7463a847b--- /dev/null+++ b/frontend/src/react/pages/project/issue-detail/utils/databaseChange.test.ts@@ -0,0 +1,18 @@+import { describe, expect, test, vi } from "vitest";+import { Engine } from "@/types/proto-es/v1/common_pb";+import { BACKUP_AVAILABLE_ENGINES } from "./databaseChange";++vi.mock("@/types", () => ({+ isValidDatabaseName: vi.fn(),+}));++vi.mock("@/utils", () => ({+ getInstanceResource: vi.fn(),+ semverCompare: vi.fn(),+}));++describe("BACKUP_AVAILABLE_ENGINES", () => {+ test("includes MariaDB", () => {+ expect(BACKUP_AVAILABLE_ENGINES).toContain(Engine.MARIADB);+ });+});diff --git a/frontend/src/react/pages/project/issue-detail/utils/databaseChange.ts b/frontend/src/react/pages/project/issue-detail/utils/databaseChange.tsindex bfd172ff91..46c34753c3 100644--- a/frontend/src/react/pages/project/issue-detail/utils/databaseChange.ts+++ b/frontend/src/react/pages/project/issue-detail/utils/databaseChange.ts@@ -6,6 +6,7 @@ import { getInstanceResource, semverCompare } from "@/utils";export const BACKUP_AVAILABLE_ENGINES = [Engine.MYSQL,+ Engine.MARIADB,Engine.TIDB,Engine.MSSQL,Engine.ORACLE,diff --git a/frontend/src/react/pages/project/plan-detail/components/PlanDetailChangesBranch.tsx b/frontend/src/react/pages/project/plan-detail/components/PlanDetailChangesBranch.tsxindex 8725a88d32..7de0220c61 100644--- a/frontend/src/react/pages/project/plan-detail/components/PlanDetailChangesBranch.tsx+++ b/frontend/src/react/pages/project/plan-detail/components/PlanDetailChangesBranch.tsx@@ -155,6 +155,7 @@ type IsolationLevel =const BACKUP_AVAILABLE_ENGINES = [Engine.MYSQL,+ Engine.MARIADB,Engine.TIDB,Engine.MSSQL,Engine.ORACLE,diff --git a/frontend/src/react/pages/project/plan-detail/utils/options.test.ts b/frontend/src/react/pages/project/plan-detail/utils/options.test.tsindex 5595cfc4f4..ff2323704d 100644--- a/frontend/src/react/pages/project/plan-detail/utils/options.test.ts+++ b/frontend/src/react/pages/project/plan-detail/utils/options.test.ts@@ -28,6 +28,18 @@ describe("getPlanOptionVisibility", () => {});});+ test("shows pre-backup for MariaDB change database configs", () => {+ expect(+ getPlanOptionVisibility({+ databases: [databaseWithEngine(Engine.MARIADB, "10.11.0")],+ isChangeDatabaseConfig: true,+ isSheetBasedDatabaseChange: true,+ })+ ).toMatchObject({+ showPreBackup: true,+ });+ });+test("hides sheet-only options for release-backed specs", () => {expect(getPlanOptionVisibility({diff --git a/frontend/src/react/pages/project/plan-detail/utils/options.ts b/frontend/src/react/pages/project/plan-detail/utils/options.tsindex 7a9e77f159..9ee6383daa 100644--- a/frontend/src/react/pages/project/plan-detail/utils/options.ts+++ b/frontend/src/react/pages/project/plan-detail/utils/options.ts@@ -3,6 +3,7 @@ import type { Database } from "@/types/proto-es/v1/database_service_pb";const BACKUP_AVAILABLE_ENGINES = [Engine.MYSQL,+ Engine.MARIADB,Engine.TIDB,Engine.MSSQL,Engine.ORACLE,diff --git a/frontend/src/types/sql-review-schema.yaml b/frontend/src/types/sql-review-schema.yamlindex a10047e4fd..8bb70f3a90 100644--- a/frontend/src/types/sql-review-schema.yaml+++ b/frontend/src/types/sql-review-schema.yaml@@ -2051,6 +2051,9 @@- type: BUILTIN_PRIOR_BACKUP_CHECKcategory: BUILTINengine: ORACLE+- type: BUILTIN_PRIOR_BACKUP_CHECK+ category: BUILTIN+ engine: MARIADB- type: BUILTIN_WALK_THROUGH_CHECKcategory: BUILTINengine: MYSQLdiff --git a/frontend/src/types/sqlReview.test.ts b/frontend/src/types/sqlReview.test.tsindex 2103dcfd1a..19b4cf92c7 100644--- a/frontend/src/types/sqlReview.test.ts+++ b/frontend/src/types/sqlReview.test.ts@@ -159,6 +159,17 @@ describe("SQL Review YAML Templates Validation", () => {).toBe("string");});});++ test("schema exposes built-in prior backup check for MariaDB", () => {+ expect(+ schemaRules.some(+ (rule) =>+ rule.engine === "MARIADB" &&+ rule.type === "BUILTIN_PRIOR_BACKUP_CHECK" &&+ rule.category === "BUILTIN"+ )+ ).toBe(true);+ });});describe("Cross-template consistency", () => {