Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
package pg
import (
"context"
"fmt"
"regexp"
"github.com/pkg/errors"
"github.com/bytebase/omni/pg/ast"
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 = (*NamingTableConventionAdvisor)(nil)
)
func init() {
advisor.Register(storepb.Engine_POSTGRES, storepb.SQLReviewRule_NAMING_TABLE, &NamingTableConventionAdvisor{})
}
// NamingTableConventionAdvisor is the advisor checking for table naming convention.
type NamingTableConventionAdvisor struct {
}
// Check checks for table naming convention.
func (*NamingTableConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
if err != nil {
return nil, err
}
namingPayload := checkCtx.Rule.GetNamingPayload()
if namingPayload == nil {
return nil, errors.New("naming_payload is required for naming table rule")
}
format, err := regexp.Compile(namingPayload.Format)
if err != nil {
return nil, errors.Wrapf(err, "failed to compile regex format %q", namingPayload.Format)
}
maxLength := int(namingPayload.MaxLength)
if maxLength == 0 {
maxLength = advisor.DefaultNameLengthLimit
}
rule := &namingTableConventionRule{
OmniBaseRule: OmniBaseRule{
Level: level,
Title: checkCtx.Rule.Type.String(),
},
format: format,
maxLength: maxLength,
}
return RunRules(checkCtx.ParsedStatements, []OmniRule{rule}), nil
}
type namingTableConventionRule struct {
OmniBaseRule
format *regexp.Regexp
maxLength int
}
func (*namingTableConventionRule) Name() string {
return string(storepb.SQLReviewRule_NAMING_TABLE)
}
func (r *namingTableConventionRule) OnStatement(node ast.Node) {
switch n := node.(type) {
case *ast.CreateStmt:
if n.Relation != nil {
r.checkTableName(n.Relation.Relname)
}
case *ast.RenameStmt:
if n.RenameType == ast.OBJECT_TABLE {
r.checkTableName(n.Newname)
}
default:
}
}
func (r *namingTableConventionRule) checkTableName(tableName string) {
if !r.format.MatchString(tableName) {
r.AddAdvice(&storepb.Advice{
Status: r.Level,
Code: code.NamingTableConventionMismatch.Int32(),
Title: r.Title,
Content: fmt.Sprintf(`"%s" mismatches table naming convention, naming format should be %q`, tableName, r.format),
StartPosition: &storepb.Position{
Line: r.ContentStartLine(),
Column: 0,
},
})
}
if r.maxLength > 0 && len(tableName) > r.maxLength {
r.AddAdvice(&storepb.Advice{
Status: r.Level,
Code: code.NamingTableConventionMismatch.Int32(),
Title: r.Title,
Content: fmt.Sprintf("\"%s\" mismatches table naming convention, its length should be within %d characters", tableName, r.maxLength),
StartPosition: &storepb.Position{
Line: r.ContentStartLine(),
Column: 0,
},
})
}
}