Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
refactor(advisor/tidb): migrate column_require_default to omni AST (Phase 1.5 §1.5.3 batch 9) (#20295)
Vincent Huang640d1ae136af
diff --git a/backend/common/engine_test.go b/backend/common/engine_test.goindex 8342ccc293..cd55a00484 100644--- a/backend/common/engine_test.go+++ b/backend/common/engine_test.go@@ -1,3 +1,4 @@+//nolint:revivepackage commonimport (diff --git a/backend/plugin/advisor/tidb/advisor_column_require_default.go b/backend/plugin/advisor/tidb/advisor_column_require_default.goindex a51cbdad6c..b263749b44 100644--- a/backend/plugin/advisor/tidb/advisor_column_require_default.go+++ b/backend/plugin/advisor/tidb/advisor_column_require_default.go@@ -1,23 +1,20 @@package tidb-// Framework code is generated by the generator.-import ("context""fmt"+ "strings"- "github.com/bytebase/bytebase/backend/plugin/advisor/code"-- "github.com/pingcap/tidb/pkg/parser/ast"+ "github.com/bytebase/omni/tidb/ast""github.com/bytebase/bytebase/backend/common"storepb "github.com/bytebase/bytebase/backend/generated-go/store""github.com/bytebase/bytebase/backend/plugin/advisor"+ "github.com/bytebase/bytebase/backend/plugin/advisor/code")var (_ advisor.Advisor = (*ColumRequireDefaultAdvisor)(nil)- _ ast.Visitor = (*columRequireDefaultChecker)(nil))func init() {@@ -30,8 +27,7 @@ type ColumRequireDefaultAdvisor struct {// Check checks for column default requirement.func (*ColumRequireDefaultAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {- stmtList, err := getTiDBNodes(checkCtx)-+ stmts, err := getTiDBOmniNodes(checkCtx)if err != nil {return nil, err}@@ -45,10 +41,8 @@ func (*ColumRequireDefaultAdvisor) Check(_ context.Context, checkCtx advisor.Contitle: checkCtx.Rule.Type.String(),}- for _, stmt := range stmtList {- checker.text = stmt.Text()- checker.line = stmt.OriginTextPosition()- (stmt).Accept(checker)+ for _, ostmt := range stmts {+ checker.checkStmt(ostmt)}return checker.adviceList, nil@@ -58,94 +52,113 @@ type columRequireDefaultChecker struct {adviceList []*storepb.Advicelevel storepb.Advice_Statustitle string- text string- line int}-func getPkColumnsFromConstraints(node *ast.CreateTableStmt) map[string]bool {- pkColumns := make(map[string]bool)- for _, constraint := range node.Constraints {- if constraint.Tp != ast.ConstraintPrimaryKey {- continue+// columnData is shared with advisor_column_auto_increment_must_integer.go+// (same package) — same {table, column, line} shape across the column+// attribute advisors.++func (c *columRequireDefaultChecker) checkStmt(ostmt OmniStmt) {+ var cols []columnData+ switch n := ostmt.Node.(type) {+ case *ast.CreateTableStmt:+ if n.Table == nil {+ return}- for _, key := range constraint.Keys {- if key.Column == nil {+ tableName := n.Table.Name+ // Table-level PK columns are exempt. Column-level PK is handled+ // inside omniNeedDefault via the column's own Constraints.+ // Names are lowercased on both sides — omni preserves user case,+ // but SQL identifier matching is case-insensitive for unquoted+ // names (and the pingcap-typed predecessor used `.L` normalization).+ pkColumns := tablePKColumnsFromConstraints(n.Constraints)+ for _, column := range n.Columns {+ if column == nil {continue}- pkColumns[key.Column.Name.L] = true- }- }- return pkColumns-}--// Enter implements the ast.Visitor interface.-func (checker *columRequireDefaultChecker) Enter(in ast.Node) (ast.Node, bool) {- var columnList []columnData- switch node := in.(type) {- case *ast.CreateTableStmt:- tableName := node.Table.Name.O- pkColumns := getPkColumnsFromConstraints(node)- for _, column := range node.Cols {- if !hasDefault(column) && needDefault(column) && !pkColumns[column.Name.Name.L] {- columnList = append(columnList, columnData{+ if pkColumns[strings.ToLower(column.Name)] {+ continue+ }+ if !omniHasDefaultValue(column) && omniNeedDefault(column) {+ cols = append(cols, columnData{table: tableName,- column: column.Name.Name.O,- line: column.OriginTextPosition(),+ column: column.Name,+ line: ostmt.AbsoluteLine(column.Loc.Start),})}}case *ast.AlterTableStmt:- tableName := node.Table.Name.O- for _, spec := range node.Specs {- switch spec.Tp {- case ast.AlterTableAddColumns:- for _, column := range spec.NewColumns {- if !hasDefault(column) && needDefault(column) {- columnList = append(columnList, columnData{- table: tableName,- column: column.Name.Name.O,- line: node.OriginTextPosition(),- })+ if n.Table == nil {+ return+ }+ tableName := n.Table.Name+ stmtLine := ostmt.AbsoluteLine(n.Loc.Start)+ for _, cmd := range n.Commands {+ if cmd == nil {+ continue+ }+ switch cmd.Type {+ case ast.ATAddColumn:+ for _, column := range addColumnTargets(cmd) {+ if column == nil {+ continue}+ if !omniHasDefaultValue(column) && omniNeedDefault(column) {+ cols = append(cols, columnData{table: tableName, column: column.Name, line: stmtLine})+ }+ }+ case ast.ATChangeColumn, ast.ATModifyColumn:+ if cmd.Column == nil {+ continue}- case ast.AlterTableChangeColumn, ast.AlterTableModifyColumn:- column := spec.NewColumns[0]- if !hasDefault(column) && needDefault(column) {- columnList = append(columnList, columnData{- table: tableName,- column: column.Name.Name.O,- line: node.OriginTextPosition(),- })+ column := cmd.Column+ if !omniHasDefaultValue(column) && omniNeedDefault(column) {+ cols = append(cols, columnData{table: tableName, column: column.Name, line: stmtLine})}default:}}default:+ return}- for _, column := range columnList {- checker.adviceList = append(checker.adviceList, &storepb.Advice{- Status: checker.level,+ for _, col := range cols {+ c.adviceList = append(c.adviceList, &storepb.Advice{+ Status: c.level,Code: code.NoDefault.Int32(),- Title: checker.title,- Content: fmt.Sprintf("Column `%s`.`%s` doesn't have DEFAULT.", column.table, column.column),- StartPosition: common.ConvertANTLRLineToPosition(column.line),+ Title: c.title,+ Content: fmt.Sprintf("Column `%s`.`%s` doesn't have DEFAULT.", col.table, col.column),+ StartPosition: common.ConvertANTLRLineToPosition(col.line),})}-- return in, false}-// Leave implements the ast.Visitor interface.-func (*columRequireDefaultChecker) Leave(in ast.Node) (ast.Node, bool) {- return in, true-}--func hasDefault(column *ast.ColumnDef) bool {- for _, option := range column.Options {- if option.Tp == ast.ColumnOptionDefaultValue {- return true+// tablePKColumnsFromConstraints returns the set of column names that appear+// in any table-level PRIMARY KEY constraint, lowercased for case-insensitive+// SQL identifier matching. Mirrors pingcap-typed getPkColumnsFromConstraints+// which used `.L` (lowercase) form for the same purpose. Callers must+// lowercase the lookup key before consulting the map (omni preserves the+// user's literal case on both column.Name and constraint.Columns, so two+// references to the same column at different casings won't match without+// normalization). Column-level PK is handled separately by omniNeedDefault+// via the column's own Constraints.+func tablePKColumnsFromConstraints(constraints []*ast.Constraint) map[string]bool {+ pkColumns := make(map[string]bool)+ for _, constraint := range constraints {+ if constraint == nil || constraint.Type != ast.ConstrPrimaryKey {+ continue+ }+ for _, columnName := range constraint.Columns {+ pkColumns[strings.ToLower(columnName)] = true}}- return false+ return pkColumns+}++// omniHasDefaultValue reports whether the column declares a DEFAULT clause.+// Mirrors pingcap-typed hasDefault. Omni surfaces DEFAULT directly on the+// column rather than via the Options/Constraints list, so this is a+// one-line nil check.+func omniHasDefaultValue(col *ast.ColumnDef) bool {+ return col != nil && col.DefaultValue != nil}diff --git a/backend/plugin/advisor/tidb/test/column_require_default.yaml b/backend/plugin/advisor/tidb/test/column_require_default.yamlindex d9df699ac0..66dfba63af 100644--- a/backend/plugin/advisor/tidb/test/column_require_default.yaml+++ b/backend/plugin/advisor/tidb/test/column_require_default.yaml@@ -53,3 +53,25 @@line: 3column: 0endposition: null+# TEXT-family transitive coverage pin (batch 9 / cumulative #18): omniNeedDefault+# treats TEXT and BLOB families identically as "default-exempt" (no meaningful+# default for blob/text columns). Pingcap unified TEXT under TypeBlob; omni+# splits TEXT into its own DataType.Name. omniNeedDefault was already correct+# (lists all 8 names); this fixture locks that contract so a future refactor+# can't drop TEXT names and silently start flagging text-without-default.+- statement: |-+ ALTER TABLE tech_book ADD COLUMN a TEXT;+ ALTER TABLE tech_book ADD COLUMN b TINYTEXT;+ ALTER TABLE tech_book ADD COLUMN c MEDIUMTEXT;+ ALTER TABLE tech_book ADD COLUMN d LONGTEXT;+ changeType: 1+# Case-insensitive PK match pin (batch 9 round-2, Codex P2): omni preserves+# the user's literal case on BOTH column.Name and constraint.Columns — no+# normalization. Pingcap's `.L` (lowercase) coalesced these for matching;+# the omni port must lowercase both sides before lookup, otherwise+# `CREATE TABLE t(A INT, PRIMARY KEY(a))` flags `A` as missing DEFAULT+# because the case-sensitive lookup misses the PK exemption.+- statement: CREATE TABLE t(A INT, PRIMARY KEY(a));+ changeType: 1+- statement: CREATE TABLE t(mycol INT, PRIMARY KEY(MyCol));+ changeType: 1diff --git a/backend/plugin/advisor/tidb/utils.go b/backend/plugin/advisor/tidb/utils.goindex 27c37c9165..a1a0759b34 100644--- a/backend/plugin/advisor/tidb/utils.go+++ b/backend/plugin/advisor/tidb/utils.go@@ -12,8 +12,6 @@ import ("unicode""github.com/pingcap/tidb/pkg/parser/ast"- "github.com/pingcap/tidb/pkg/parser/mysql"- "github.com/pingcap/tidb/pkg/parser/types""github.com/pkg/errors"omniast "github.com/bytebase/omni/tidb/ast"@@ -59,28 +57,6 @@ func (t tablePK) tableList() []string {return tableList}-func needDefault(column *ast.ColumnDef) bool {- for _, option := range column.Options {- switch option.Tp {- case ast.ColumnOptionAutoIncrement, ast.ColumnOptionPrimaryKey, ast.ColumnOptionGenerated:- return false- default:- // Other options- }- }-- if types.IsTypeBlob(column.Tp.GetType()) {- return false- }- switch column.Tp.GetType() {- case mysql.TypeJSON, mysql.TypeGeometry:- return false- default:- // Other types can have default values- }- return true-}-// getTiDBNodes extracts pingcap-AST nodes for un-migrated advisors.//// On a PingCapASTProvider whose AsPingCapAST returns (nil, false) — i.e.@@ -424,11 +400,6 @@ func addColumnTargets(cmd *omniast.AlterTableCmd) []*omniast.ColumnDef {// - column type is BLOB/TEXT (omni stores TEXT as a separate name from// BLOB; pingcap unified them under TypeBlob — both must be checked)// - column type is JSON or geometry (no meaningful default)-//-// Mirror of pingcap-typed needDefault (still in utils.go for the-// un-migrated advisor_column_require_default.go consumer).-// When that advisor migrates, switch its calls here and delete needDefault.-// Tracked: https://linear.app/bytebase/issue/BYT-9414func omniNeedDefault(col *omniast.ColumnDef) bool {if col == nil {return falsediff --git a/backend/plugin/db/util/driverutil_test.go b/backend/plugin/db/util/driverutil_test.goindex 0f6c43448a..d428451f0e 100644--- a/backend/plugin/db/util/driverutil_test.go+++ b/backend/plugin/db/util/driverutil_test.go@@ -1,3 +1,4 @@+//nolint:revivepackage utilimport (