Skip to content

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

feat: activate ANTLR-based PostgreSQL parser (#17882)

h3n4l2349bc440621
diff --git a/backend/plugin/advisor/pg/advisor_builtin_prior_backup_check.go b/backend/plugin/advisor/pg/advisor_builtin_prior_backup_check.go
deleted file mode 100644
index 6478d3a528..0000000000
--- a/backend/plugin/advisor/pg/advisor_builtin_prior_backup_check.go
+++ /dev/null
@@ -1,241 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "log/slog"
-
- "github.com/antlr4-go/antlr/v4"
- "github.com/pkg/errors"
-
- parser "github.com/bytebase/parser/postgresql"
-
- "github.com/bytebase/bytebase/backend/common"
- "github.com/bytebase/bytebase/backend/common/log"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-const (
- defaultSchema = "public"
-)
-
-var (
- _ advisor.Advisor = (*BuiltinPriorBackupCheckAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.BuiltinRulePriorBackupCheck, &BuiltinPriorBackupCheckAdvisor{})
-}
-
-// BuiltinPriorBackupCheckAdvisor is the advisor checking for disallow mix DDL and DML.
-type BuiltinPriorBackupCheckAdvisor struct {
-}
-
-// Check checks for disallow mix DDL and DML.
-func (*BuiltinPriorBackupCheckAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- if !checkCtx.EnablePriorBackup || checkCtx.ChangeType != storepb.PlanCheckRunConfig_DML {
- return nil, nil
- }
- var adviceList []*storepb.Advice
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- title := string(checkCtx.Rule.Type)
-
- for _, stmt := range stmtList {
- if _, ok := stmt.(ast.DDLNode); ok {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Data change can only run DML, \"%s\" is not DML", stmt.Text()),
- Code: advisor.BuiltinPriorBackupCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
-
- schemaName := common.BackupDatabaseNameOfEngine(storepb.Engine_POSTGRES)
- if !checkCtx.Catalog.Origin.HasSchema(schemaName) {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Need schema %q to do prior backup but it does not exist", schemaName),
- Code: advisor.SchemaNotExists.Int32(),
- StartPosition: nil,
- })
- }
-
- statementInfoList, err := prepareTransformation(checkCtx.Statements)
- if err != nil {
- return nil, errors.Wrapf(err, "failed to prepare transformation")
- }
-
- groupByTable := make(map[string][]statementInfo)
- for _, item := range statementInfoList {
- key := fmt.Sprintf("%s.%s", item.table.Schema, item.table.Table)
- groupByTable[key] = append(groupByTable[key], item)
- }
-
- // Check if the statement type is the same for all statements on the same table.
- for key, list := range groupByTable {
- statementType := StatementTypeUnknown
- for _, item := range list {
- if statementType == StatementTypeUnknown {
- statementType = item.table.StatementType
- }
- if statementType != item.table.StatementType {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("The statement type is not the same for all statements on the same table %q", key),
- Code: advisor.BuiltinPriorBackupCheck.Int32(),
- StartPosition: nil,
- })
- break
- }
- }
- }
-
- return adviceList, nil
-}
-
-type StatementType int
-
-const (
- StatementTypeUnknown StatementType = iota
- StatementTypeUpdate
- StatementTypeInsert
- StatementTypeDelete
-)
-
-type TableReference struct {
- Database string
- Schema string
- Table string
- Alias string
- StatementType StatementType
-}
-
-type statementInfo struct {
- offset int
- statement string
- tree antlr.ParserRuleContext
- table *TableReference
-}
-
-func prepareTransformation(statement string) ([]statementInfo, error) {
- tree, err := pg.ParsePostgreSQL(statement)
- if err != nil {
- return nil, errors.Wrap(err, "failed to parse statement")
- }
-
- extractor := &dmlExtractor{}
- antlr.ParseTreeWalkerDefault.Walk(extractor, tree.Tree)
- return extractor.dmls, nil
-}
-
-type dmlExtractor struct {
- *parser.BasePostgreSQLParserListener
-
- dmls []statementInfo
- offset int
-}
-
-func isTopLevel(ctx antlr.Tree) bool {
- if ctx == nil {
- return true
- }
-
- switch ctx := ctx.(type) {
- case *parser.RootContext, *parser.StmtblockContext:
- return true
- case *parser.StmtmultiContext, *parser.StmtContext:
- return isTopLevel(ctx.GetParent())
- default:
- return false
- }
-}
-
-func (e *dmlExtractor) ExitStmt(ctx *parser.StmtContext) {
- if isTopLevel(ctx) {
- e.offset++
- }
-}
-
-func (e *dmlExtractor) EnterUpdatestmt(ctx *parser.UpdatestmtContext) {
- if isTopLevel(ctx.GetParent()) {
- table := extractTableReference(ctx.Relation_expr_opt_alias())
- if table == nil {
- return
- }
- table.StatementType = StatementTypeUpdate
- e.dmls = append(e.dmls, statementInfo{
- offset: e.offset,
- statement: ctx.GetParser().GetTokenStream().GetTextFromRuleContext(ctx),
- tree: ctx,
- table: table,
- })
- }
-}
-
-func (e *dmlExtractor) EnterDeletestmt(ctx *parser.DeletestmtContext) {
- if isTopLevel(ctx.GetParent()) {
- table := extractTableReference(ctx.Relation_expr_opt_alias())
- if table == nil {
- return
- }
- table.StatementType = StatementTypeDelete
- e.dmls = append(e.dmls, statementInfo{
- offset: e.offset,
- statement: ctx.GetParser().GetTokenStream().GetTextFromRuleContext(ctx),
- tree: ctx,
- table: table,
- })
- }
-}
-
-func extractTableReference(ctx parser.IRelation_expr_opt_aliasContext) *TableReference {
- if ctx == nil {
- return nil
- }
-
- table := TableReference{}
-
- relationExpr := ctx.Relation_expr()
- if relationExpr == nil {
- return nil
- }
-
- list := pg.NormalizePostgreSQLQualifiedName(relationExpr.Qualified_name())
- switch len(list) {
- case 3:
- table.Database = list[0]
- table.Schema = list[1]
- table.Table = list[2]
- case 2:
- table.Schema = list[0]
- table.Table = list[1]
- case 1:
- table.Schema = defaultSchema
- table.Table = list[0]
- default:
- slog.Debug("Invalid table name", log.BBError(errors.Errorf("Invalid table name: %v", list)))
- return nil
- }
-
- if ctx.Colid() != nil {
- table.Alias = pg.NormalizePostgreSQLColid(ctx.Colid())
- }
- return &table
-}
diff --git a/backend/plugin/advisor/pg/advisor_collation_allowlist.go b/backend/plugin/advisor/pg/advisor_collation_allowlist.go
deleted file mode 100644
index d9d86ba002..0000000000
--- a/backend/plugin/advisor/pg/advisor_collation_allowlist.go
+++ /dev/null
@@ -1,128 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*CollationAllowlistAdvisor)(nil)
- _ ast.Visitor = (*collationAllowlistChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleCollationAllowlist, &CollationAllowlistAdvisor{})
-}
-
-// CollationAllowlistAdvisor is the advisor checking for collation allowlist.
-type CollationAllowlistAdvisor struct {
-}
-
-// Check checks for collation allowlist.
-func (*CollationAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &collationAllowlistChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- allowlist: make(map[string]bool),
- }
- for _, collation := range payload.List {
- checker.allowlist[collation] = true
- }
-
- for _, stmt := range stmtList {
- checker.text = advisor.NormalizeStatement(stmt.Text())
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type collationAllowlistChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- allowlist map[string]bool
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *collationAllowlistChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
- line := 0
- disabledCollation := ""
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, column := range node.ColumnList {
- if column.Collation != nil {
- if _, exists := checker.allowlist[column.Collation.Name]; !exists {
- code = advisor.DisabledCollation
- line = column.LastLine()
- disabledCollation = column.Collation.Name
- break
- }
- }
- }
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- switch itemNode := item.(type) {
- case *ast.AddColumnListStmt:
- for _, column := range itemNode.ColumnList {
- if column.Collation != nil {
- if _, exists := checker.allowlist[column.Collation.Name]; !exists {
- code = advisor.DisabledCollation
- line = node.LastLine()
- disabledCollation = column.Collation.Name
- break
- }
- }
- }
- case *ast.AlterColumnTypeStmt:
- if itemNode.Collation != nil {
- if _, exists := checker.allowlist[itemNode.Collation.Name]; !exists {
- code = advisor.DisabledCollation
- line = node.LastLine()
- disabledCollation = itemNode.Collation.Name
- break
- }
- }
- }
-
- if code != advisor.Ok {
- break
- }
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Use disabled collation \"%s\", related statement \"%s\"", disabledCollation, checker.text),
- StartPosition: newPositionAtLineStart(line),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_comment_convention.go b/backend/plugin/advisor/pg/advisor_column_comment_convention.go
deleted file mode 100644
index 73fd336f3a..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_comment_convention.go
+++ /dev/null
@@ -1,151 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- "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/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnCommentConventionAdvisor)(nil)
- _ ast.Visitor = (*columnCommentConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnCommentConvention, &ColumnCommentConventionAdvisor{})
-}
-
-// ColumnCommentConventionAdvisor is the advisor checking for column comment convention.
-type ColumnCommentConventionAdvisor struct {
-}
-
-func (*ColumnCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &columnCommentConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- payload: payload,
- classificationConfig: checkCtx.ClassificationConfig,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- for _, columnName := range checker.columnNameList {
- var commentStmt *ast.CommentStmt
- for _, stmt := range checker.commentStmtList {
- columnNameDef, ok := stmt.Object.(*ast.ColumnNameDef)
- if !ok {
- continue
- }
- if columnNameDef.ColumnName == columnName.ColumnName && columnNameDef.Table.Name == columnName.Table.Name {
- commentStmt = stmt
- // continue and find the last comment statement.
- }
- }
- if commentStmt == nil || commentStmt.Comment == "" {
- if checker.payload.Required {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentEmpty.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Comment is required for column `%s`", stringifyColumnNameDef(columnName)),
- StartPosition: newPositionAtLineStart(columnName.LastLine()),
- })
- }
- } else {
- comment := commentStmt.Comment
- if checker.payload.MaxLength > 0 && len(comment) > checker.payload.MaxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentTooLong.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Column `%s` comment is too long. The length of comment should be within %d characters", stringifyColumnNameDef(columnName), checker.payload.MaxLength),
- StartPosition: newPositionAtLineStart(commentStmt.LastLine()),
- })
- }
- if checker.payload.RequiredClassification {
- if classification, _ := common.GetClassificationAndUserComment(comment, checker.classificationConfig); classification == "" {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentMissingClassification.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Column `%s` comment requires classification", stringifyColumnNameDef(columnName)),
- StartPosition: newPositionAtLineStart(commentStmt.LastLine()),
- })
- }
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-type columnCommentConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- payload *advisor.CommentConventionRulePayload
- classificationConfig *storepb.DataClassificationSetting_DataClassificationConfig
-
- columnNameList []*ast.ColumnNameDef
- commentStmtList []*ast.CommentStmt
-}
-
-func (checker *columnCommentConventionChecker) Visit(node ast.Node) ast.Visitor {
- if createTableStmt, ok := node.(*ast.CreateTableStmt); ok {
- for _, columnDef := range createTableStmt.ColumnList {
- columnName := &ast.ColumnNameDef{
- Table: createTableStmt.Name,
- ColumnName: columnDef.ColumnName,
- }
- columnName.SetLastLine(createTableStmt.LastLine())
- checker.columnNameList = append(checker.columnNameList, columnName)
- }
- } else if alterTableStmt, ok := node.(*ast.AlterTableStmt); ok {
- for _, alterItem := range alterTableStmt.AlterItemList {
- if addColumnListStmt, ok := alterItem.(*ast.AddColumnListStmt); ok {
- for _, columnDef := range addColumnListStmt.ColumnList {
- columnName := &ast.ColumnNameDef{
- Table: alterTableStmt.Table,
- ColumnName: columnDef.ColumnName,
- }
- columnName.SetLastLine(alterTableStmt.LastLine())
- checker.columnNameList = append(checker.columnNameList, columnName)
- }
- }
- }
- } else if commentStmt, ok := node.(*ast.CommentStmt); ok && commentStmt.Type == ast.ObjectTypeColumn {
- checker.commentStmtList = append(checker.commentStmtList, commentStmt)
- }
- return checker
-}
-
-func stringifyColumnNameDef(columnName *ast.ColumnNameDef) string {
- if columnName == nil {
- return ""
- }
- if columnName.Table == nil {
- return columnName.ColumnName
- }
- return fmt.Sprintf("%s.%s", columnName.Table.Name, columnName.ColumnName)
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_default_disallow_volatile.go b/backend/plugin/advisor/pg/advisor_column_default_disallow_volatile.go
deleted file mode 100644
index 2c58c97611..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_default_disallow_volatile.go
+++ /dev/null
@@ -1,140 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "slices"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnDefaultDisallowVolatileAdvisor)(nil)
- _ ast.Visitor = (*columnDefaultDisallowVolatileChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnDefaultDisallowVolatile, &ColumnDefaultDisallowVolatileAdvisor{})
-}
-
-// ColumnRequireDefaultAdvisor is the advisor checking for column default requirement.
-type ColumnDefaultDisallowVolatileAdvisor struct {
-}
-
-// Check checks for column default requirement.
-func (*ColumnDefaultDisallowVolatileAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &columnDefaultDisallowVolatileChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- catalog: checkCtx.Catalog,
- columnSet: make(map[string]columnData),
- }
-
- if checker.catalog.Final.Usable() {
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
- }
-
- return checker.generateAdvice(), nil
-}
-
-type columnDefaultDisallowVolatileChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- columnSet map[string]columnData
- catalog *catalog.Finder
-}
-
-func (checker *columnDefaultDisallowVolatileChecker) generateAdvice() []*storepb.Advice {
- var columnList []columnData
- for _, column := range checker.columnSet {
- columnList = append(columnList, column)
- }
- slices.SortFunc(columnList, func(i, j columnData) int {
- if i.line < j.line {
- return -1
- }
- if i.line > j.line {
- return 1
- }
- return 0
- })
-
- for _, column := range columnList {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NoDefault.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Column %q.%q in schema %q has volatile DEFAULT", column.table, column.name, column.schema),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
-
- return checker.adviceList
-}
-
-func (checker *columnDefaultDisallowVolatileChecker) addColumn(schema string, table string, column string, line int) {
- if schema == "" {
- schema = "public"
- }
-
- checker.columnSet[fmt.Sprintf("%s.%s.%s", schema, table, column)] = columnData{
- schema: schema,
- table: table,
- name: column,
- line: line,
- }
-}
-
-func (checker *columnDefaultDisallowVolatileChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.AlterTableStmt); ok {
- for _, item := range node.AlterItemList {
- if addColumn, ok := item.(*ast.AddColumnListStmt); ok {
- for _, column := range addColumn.ColumnList {
- if hasVolatile(column) {
- checker.addColumn(node.Table.Schema, node.Table.Name, column.ColumnName, node.LastLine())
- }
- }
- }
- }
- }
- return checker
-}
-
-func hasVolatile(column *ast.ColumnDef) bool {
- for _, c := range column.ConstraintList {
- if c.Type != ast.ConstraintTypeDefault {
- continue
- }
- switch c.Expression.(type) {
- case *ast.UnconvertedExpressionDef:
- // All functions belong to this type in the converter.
- return true
- case *ast.IntegerDef:
- continue
- case *ast.StringDef:
- continue
- case *ast.BoolDef:
- continue
- }
- }
- return false
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_disallow_changing_type.go b/backend/plugin/advisor/pg/advisor_column_disallow_changing_type.go
deleted file mode 100644
index 805f614bdc..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_disallow_changing_type.go
+++ /dev/null
@@ -1,80 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnDisallowChangingTypeAdvisor)(nil)
- _ ast.Visitor = (*columnDisallowChangingTypeChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnDisallowChangeType, &ColumnDisallowChangingTypeAdvisor{})
-}
-
-// ColumnDisallowChangingTypeAdvisor is the advisor checking for disallow changing column type.
-type ColumnDisallowChangingTypeAdvisor struct {
-}
-
-// Check checks for disallow changing column type.
-func (*ColumnDisallowChangingTypeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &columnDisallowChangingTypeChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type columnDisallowChangingTypeChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- text string
- line int
- title string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *columnDisallowChangingTypeChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
- if _, ok := in.(*ast.AlterColumnTypeStmt); ok {
- code = advisor.ChangeColumnType
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The statement \"%s\" changes column type", checker.text),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go b/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go
deleted file mode 100644
index 8e5fa090ce..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_maximum_character_length.go
+++ /dev/null
@@ -1,126 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnMaximumCharacterLengthAdvisor)(nil)
- _ ast.Visitor = (*columnMaximumCharacterLengthChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnMaximumCharacterLength, &ColumnMaximumCharacterLengthAdvisor{})
-}
-
-// ColumnMaximumCharacterLengthAdvisor is the advisor checking for maximum character length.
-type ColumnMaximumCharacterLengthAdvisor struct {
-}
-
-// Check checks for maximum character length.
-func (*ColumnMaximumCharacterLengthAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &columnMaximumCharacterLengthChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- maximum: payload.Number,
- }
-
- if payload.Number > 0 {
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
- }
-
- return checker.adviceList, nil
-}
-
-type columnMaximumCharacterLengthChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- maximum int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *columnMaximumCharacterLengthChecker) Visit(in ast.Node) ast.Visitor {
- var tableName, columnName string
- var line int
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, column := range node.ColumnList {
- charLength := getCharLength(column)
- if charLength > checker.maximum {
- tableName = normalizeTableName(node.Name)
- columnName = column.ColumnName
- line = column.LastLine()
- break
- }
- }
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- switch itemNode := item.(type) {
- case *ast.AddColumnListStmt:
- for _, column := range itemNode.ColumnList {
- charLength := getCharLength(column)
- if charLength > checker.maximum {
- tableName = normalizeTableName(node.Table)
- columnName = column.ColumnName
- line = itemNode.LastLine()
- }
- }
- case *ast.AlterColumnTypeStmt:
- if char, ok := itemNode.Type.(*ast.Character); ok {
- if char.Size > checker.maximum {
- tableName = normalizeTableName(node.Table)
- columnName = itemNode.ColumnName
- line = itemNode.LastLine()
- }
- }
- }
- if tableName != "" {
- break
- }
- }
- }
-
- if tableName != "" {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CharLengthExceedsLimit.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`The length of the CHAR column %q in table %s is bigger than %d, please use VARCHAR instead`, columnName, tableName, checker.maximum),
- StartPosition: newPositionAtLineStart(line),
- })
- }
-
- return checker
-}
-
-func getCharLength(column *ast.ColumnDef) int {
- if char, ok := column.Type.(*ast.Character); ok {
- return char.Size
- }
- return 0
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_no_null.go b/backend/plugin/advisor/pg/advisor_column_no_null.go
deleted file mode 100644
index a68fa6f292..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_no_null.go
+++ /dev/null
@@ -1,184 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "slices"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnNoNullAdvisor)(nil)
- _ ast.Visitor = (*columnNoNullChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnNotNull, &ColumnNoNullAdvisor{})
-}
-
-// ColumnNoNullAdvisor is the advisor checking for column no NULL value.
-type ColumnNoNullAdvisor struct {
-}
-
-// Check checks for column no NULL value.
-func (*ColumnNoNullAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &columnNoNullChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- catalog: checkCtx.Catalog,
- nullableColumns: make(columnMap),
- }
-
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.generateAdviceList(), nil
-}
-
-type columnNoNullChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- catalog *catalog.Finder
- nullableColumns columnMap
-}
-
-func (checker *columnNoNullChecker) generateAdviceList() []*storepb.Advice {
- var columnList []columnName
- for column := range checker.nullableColumns {
- columnList = append(columnList, column)
- }
- if len(columnList) > 0 {
- // Order it cause the random iteration order in Go, see https://go.dev/blog/maps
- slices.SortFunc(columnList, func(i, j columnName) int {
- if i.schema != j.schema {
- if i.schema < j.schema {
- return -1
- }
- return 1
- }
- if i.table != j.table {
- if i.table < j.table {
- return -1
- }
- return 1
- }
- if i.column < j.column {
- return -1
- }
- if i.column > j.column {
- return 1
- }
- return 0
- })
- }
- for _, column := range columnList {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.ColumnCannotNull.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Column "%s" in %s cannot have NULL value`, column.column, column.normalizeTableName()),
- StartPosition: newPositionAtLineStart(checker.nullableColumns[column]),
- })
- }
-
- return checker.adviceList
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *columnNoNullChecker) Visit(node ast.Node) ast.Visitor {
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- for _, column := range n.ColumnList {
- checker.addColumn(n.Name, column.ColumnName, column.LastLine())
- checker.removeColumnByConstraintList(n.Name, column.ConstraintList)
- }
- checker.removeColumnByConstraintList(n.Name, n.ConstraintList)
- // ALTER TABLE
- case *ast.AlterTableStmt:
- for _, item := range n.AlterItemList {
- switch cmd := item.(type) {
- // ALTER TABLE ADD COLUMN
- case *ast.AddColumnListStmt:
- for _, column := range cmd.ColumnList {
- checker.addColumn(n.Table, column.ColumnName, n.LastLine())
- checker.removeColumnByConstraintList(n.Table, column.ConstraintList)
- }
- // ALTER TABLE ALTER COLUMN SET NOT NULL
- case *ast.SetNotNullStmt:
- checker.removeColumn(n.Table, cmd.ColumnName)
- // ALTER TABLE ALTER COLUMN DROP NOT NULL
- case *ast.DropNotNullStmt:
- checker.addColumn(n.Table, cmd.ColumnName, n.LastLine())
- // ALTER TABLE ADD CONSTRAINT
- case *ast.AddConstraintStmt:
- checker.removeColumnByConstraintList(n.Table, []*ast.ConstraintDef{cmd.Constraint})
- }
- }
- }
-
- return checker
-}
-
-func (checker *columnNoNullChecker) addColumn(table *ast.TableDef, column string, line int) {
- checker.nullableColumns[convertToColumnName(table, column)] = line
-}
-
-func (checker *columnNoNullChecker) removeColumn(table *ast.TableDef, column string) {
- delete(checker.nullableColumns, convertToColumnName(table, column))
-}
-
-func (checker *columnNoNullChecker) removeColumnByConstraintList(table *ast.TableDef, constraintList []*ast.ConstraintDef) {
- for _, constraint := range constraintList {
- switch constraint.Type {
- case ast.ConstraintTypeNotNull, ast.ConstraintTypePrimary:
- for _, column := range constraint.KeyList {
- checker.removeColumn(table, column)
- }
- case ast.ConstraintTypePrimaryUsingIndex:
- _, index := checker.catalog.Origin.FindIndex(&catalog.IndexFind{
- SchemaName: normalizeSchemaName(table.Schema),
- TableName: table.Name,
- IndexName: constraint.IndexName,
- })
- if index == nil {
- continue
- }
- for _, expression := range index.ExpressionList() {
- checker.removeColumn(table, expression)
- }
- default:
- // Other constraint types
- }
- }
-}
-
-func convertToColumnName(table *ast.TableDef, column string) columnName {
- colName := columnName{
- schema: table.Schema,
- table: table.Name,
- column: column,
- }
- if colName.schema == "" {
- colName.schema = PostgreSQLPublicSchema
- }
- return colName
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_require_default.go b/backend/plugin/advisor/pg/advisor_column_require_default.go
deleted file mode 100644
index a239057dda..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_require_default.go
+++ /dev/null
@@ -1,139 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "slices"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnRequireDefaultAdvisor)(nil)
- _ ast.Visitor = (*columnRequireDefaultChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnRequireDefault, &ColumnRequireDefaultAdvisor{})
-}
-
-// ColumnRequireDefaultAdvisor is the advisor checking for column default requirement.
-type ColumnRequireDefaultAdvisor struct {
-}
-
-// Check checks for column default requirement.
-func (*ColumnRequireDefaultAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &columnRequireDefaultChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- catalog: checkCtx.Catalog,
- columnSet: make(map[string]columnData),
- }
-
- if checker.catalog.Final.Usable() {
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
- }
-
- return checker.generateAdvice(), nil
-}
-
-type columnRequireDefaultChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- columnSet map[string]columnData
- catalog *catalog.Finder
-}
-
-type columnData struct {
- schema string
- table string
- name string
- line int
-}
-
-func (checker *columnRequireDefaultChecker) generateAdvice() []*storepb.Advice {
- var columnList []columnData
- for _, column := range checker.columnSet {
- columnList = append(columnList, column)
- }
- slices.SortFunc(columnList, func(i, j columnData) int {
- if i.line < j.line {
- return -1
- }
- if i.line > j.line {
- return 1
- }
- return 0
- })
-
- for _, column := range columnList {
- columnInfo := checker.catalog.Final.FindColumn(&catalog.ColumnFind{
- SchemaName: column.schema,
- TableName: column.table,
- ColumnName: column.name,
- })
- if columnInfo != nil && !columnInfo.HasDefault() {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NoDefault.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Column %q.%q in schema %q doesn't have DEFAULT", column.table, column.name, column.schema),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
- }
-
- return checker.adviceList
-}
-
-func (checker *columnRequireDefaultChecker) addColumn(schema string, table string, column string, line int) {
- if schema == "" {
- schema = "public"
- }
-
- checker.columnSet[fmt.Sprintf("%s.%s.%s", schema, table, column)] = columnData{
- schema: schema,
- table: table,
- name: column,
- line: line,
- }
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *columnRequireDefaultChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, column := range node.ColumnList {
- checker.addColumn(node.Name.Schema, node.Name.Name, column.ColumnName, column.LastLine())
- }
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- if addColumn, ok := item.(*ast.AddColumnListStmt); ok {
- for _, column := range addColumn.ColumnList {
- checker.addColumn(node.Table.Schema, node.Table.Name, column.ColumnName, node.LastLine())
- }
- }
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_required.go b/backend/plugin/advisor/pg/advisor_column_required.go
deleted file mode 100644
index a471ff6d27..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_required.go
+++ /dev/null
@@ -1,114 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "slices"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*ColumnRequirementAdvisor)(nil)
- _ ast.Visitor = (*columnRequirementChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleRequiredColumn, &ColumnRequirementAdvisor{})
-}
-
-type columnSet map[string]bool
-
-// ColumnRequirementAdvisor is the advisor checking for column requirement.
-type ColumnRequirementAdvisor struct {
-}
-
-// Check checks for the column requirement.
-func (*ColumnRequirementAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- columnList, err := advisor.UnmarshalRequiredColumnList(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &columnRequirementChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- checker.requiredColumns = make(columnSet)
- for _, column := range columnList {
- checker.requiredColumns[column] = true
- }
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type columnRequirementChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- requiredColumns columnSet
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *columnRequirementChecker) Visit(node ast.Node) ast.Visitor {
- var table *ast.TableDef
- var missingColumns []string
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- for _, column := range n.ColumnList {
- delete(checker.requiredColumns, column.ColumnName)
- }
- if len(checker.requiredColumns) > 0 {
- table = n.Name
- for column := range checker.requiredColumns {
- missingColumns = append(missingColumns, column)
- }
- }
- // ALTER TABLE DROP COLUMN
- case *ast.DropColumnStmt:
- if _, yes := checker.requiredColumns[n.ColumnName]; yes {
- table = n.Table
- missingColumns = append(missingColumns, n.ColumnName)
- }
- // ALTER TABLE RENAME COLUMN
- case *ast.RenameColumnStmt:
- if _, yes := checker.requiredColumns[n.ColumnName]; yes && n.ColumnName != n.NewName {
- table = n.Table
- missingColumns = append(missingColumns, n.ColumnName)
- }
- }
-
- if len(missingColumns) > 0 {
- // Order it cause the random iteration order in Go, see https://go.dev/blog/maps
- slices.Sort(missingColumns)
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NoRequiredColumn.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Table %q requires columns: %s", table.Name, strings.Join(missingColumns, ", ")),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go b/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go
deleted file mode 100644
index e9669104e2..0000000000
--- a/backend/plugin/advisor/pg/advisor_column_type_disallow_list.go
+++ /dev/null
@@ -1,148 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnTypeDisallowList, &ColumnTypeDisallowListAdvisor{})
-}
-
-// ColumnTypeDisallowListAdvisor is the advisor checking for column type restriction.
-type ColumnTypeDisallowListAdvisor struct {
-}
-
-// Check checks for column type restriction.
-func (*ColumnTypeDisallowListAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &columnTypeDisallowListChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- typeRestriction: make(map[string]bool),
- }
- for _, tp := range payload.List {
- checker.typeRestriction[strings.ToLower(tp)] = true
- }
-
- for _, stmt := range stmtList {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type columnTypeDisallowListChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
- typeRestriction map[string]bool
-}
-
-type columnTypeData struct {
- table string
- column string
- tp string
- line int
-}
-
-func (checker *columnTypeDisallowListChecker) Visit(in ast.Node) ast.Visitor {
- var columnList []columnTypeData
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, column := range node.ColumnList {
- exist := false
- typeDisallow := ""
- for tp := range checker.typeRestriction {
- if exist = column.Type.EquivalentType(tp); exist {
- typeDisallow = tp
- break
- }
- }
- if exist {
- columnList = append(columnList, columnTypeData{
- table: node.Name.Name,
- column: column.ColumnName,
- tp: strings.ToUpper(typeDisallow),
- line: column.LastLine(),
- })
- }
- }
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- switch cmd := item.(type) {
- case *ast.AddColumnListStmt:
- for _, column := range cmd.ColumnList {
- exist := false
- typeDisallow := ""
- for tp := range checker.typeRestriction {
- if exist = column.Type.EquivalentType(tp); exist {
- typeDisallow = tp
- break
- }
- }
- if exist {
- columnList = append(columnList, columnTypeData{
- table: node.Table.Name,
- column: column.ColumnName,
- tp: strings.ToUpper(typeDisallow),
- line: checker.line,
- })
- }
- }
- case *ast.ChangeColumnStmt:
- exist := false
- typeDisallow := ""
- for tp := range checker.typeRestriction {
- if exist = cmd.Column.Type.EquivalentType(tp); exist {
- typeDisallow = tp
- break
- }
- }
- if exist {
- columnList = append(columnList, columnTypeData{
- table: node.Table.Name,
- column: cmd.Column.ColumnName,
- tp: strings.ToUpper(typeDisallow),
- line: checker.line,
- })
- }
- }
- }
- }
-
- for _, column := range columnList {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.DisabledColumnType.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Disallow column type %s but column \"%s\".\"%s\" is", column.tp, column.table, column.column),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_comment_convention.go b/backend/plugin/advisor/pg/advisor_comment_convention.go
deleted file mode 100644
index 4e2218ed75..0000000000
--- a/backend/plugin/advisor/pg/advisor_comment_convention.go
+++ /dev/null
@@ -1,90 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*CommentConventionAdvisor)(nil)
- _ ast.Visitor = (*commentConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleCommentLength, &CommentConventionAdvisor{})
-}
-
-// CommentConventionAdvisor is the advisor checking for comment convention.
-type CommentConventionAdvisor struct {
-}
-
-// Check checks for comment convention.
-func (*CommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &commentConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- maxLength: payload.Number,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type commentConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- maxLength int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *commentConventionChecker) Visit(node ast.Node) ast.Visitor {
- type commentData struct {
- comment string
- line int
- }
- var comment commentData
-
- if n, ok := node.(*ast.CommentStmt); ok {
- comment = commentData{
- comment: n.Comment,
- line: n.LastLine(),
- }
- }
-
- if checker.maxLength > 0 && len(comment.comment) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentTooLong.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The length of comment should be within %d characters", checker.maxLength),
- StartPosition: newPositionAtLineStart(comment.line),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_encoding_allowlist.go b/backend/plugin/advisor/pg/advisor_encoding_allowlist.go
deleted file mode 100644
index 02da03d830..0000000000
--- a/backend/plugin/advisor/pg/advisor_encoding_allowlist.go
+++ /dev/null
@@ -1,107 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*EncodingAllowlistAdvisor)(nil)
- _ ast.Visitor = (*encodingAllowlistChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleCharsetAllowlist, &EncodingAllowlistAdvisor{})
-}
-
-// EncodingAllowlistAdvisor is the advisor checking for encoding allowlist.
-type EncodingAllowlistAdvisor struct {
-}
-
-// Check checks for encoding allowlist.
-func (*EncodingAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &encodingAllowlistChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- allowlist: make(map[string]bool),
- }
-
- for _, encoding := range payload.List {
- checker.allowlist[strings.ToLower(encoding)] = true
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type encodingAllowlistChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
- allowlist map[string]bool
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *encodingAllowlistChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
- var disabledEncoding string
- line := checker.line
- switch node := in.(type) {
- case *ast.CreateDatabaseStmt:
- encoding := getDatabaseEncoding(node.OptionList)
- if _, exist := checker.allowlist[encoding]; encoding != "" && !exist {
- code = advisor.DisabledCharset
- disabledEncoding = encoding
- }
- default:
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" used disabled encoding '%s'", checker.text, disabledEncoding),
- StartPosition: newPositionAtLineStart(line),
- })
- }
-
- return checker
-}
-
-func getDatabaseEncoding(optionList []*ast.DatabaseOptionDef) string {
- for _, option := range optionList {
- if option.Type == ast.DatabaseOptionEncoding {
- return strings.ToLower(option.Value)
- }
- }
-
- return ""
-}
diff --git a/backend/plugin/advisor/pg/advisor_index_create_concurrently.go b/backend/plugin/advisor/pg/advisor_index_create_concurrently.go
deleted file mode 100644
index 33a1b7b32b..0000000000
--- a/backend/plugin/advisor/pg/advisor_index_create_concurrently.go
+++ /dev/null
@@ -1,103 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*IndexConcurrentlyAdvisor)(nil)
- _ ast.Visitor = (*indexCreateConcurrentlyChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleCreateIndexConcurrently, &IndexConcurrentlyAdvisor{})
-}
-
-// IndexConcurrentlyAdvisor is the advisor checking for to create index concurrently.
-type IndexConcurrentlyAdvisor struct {
-}
-
-// Check checks for to create index concurrently.
-func (*IndexConcurrentlyAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- // First pass: collect all newly created tables
- newlyCreatedTables := make(map[string]bool)
- for _, stmt := range stmtList {
- if createTable, ok := stmt.(*ast.CreateTableStmt); ok {
- tableName := normalizeTableName(createTable.Name)
- newlyCreatedTables[tableName] = true
- }
- }
-
- checker := &indexCreateConcurrentlyChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- newlyCreatedTables: newlyCreatedTables,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type indexCreateConcurrentlyChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- newlyCreatedTables map[string]bool
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *indexCreateConcurrentlyChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- case *ast.CreateIndexStmt:
- if !node.Concurrently {
- // Check if the index is being created on a newly created table
- if node.Index != nil && node.Index.Table != nil {
- tableName := normalizeTableName(node.Index.Table)
- // Skip the check if the table is newly created
- if checker.newlyCreatedTables[tableName] {
- return checker
- }
- }
-
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CreateIndexUnconcurrently.Int32(),
- Title: checker.title,
- Content: "Creating indexes will block writes on the table, unless use CONCURRENTLY",
- StartPosition: newPositionAtLineStart(in.LastLine()),
- })
- }
- case *ast.DropIndexStmt:
- if !node.Concurrently {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.DropIndexUnconcurrently.Int32(),
- Title: checker.title,
- Content: "Droping indexes will block writes on the table, unless use CONCURRENTLY",
- StartPosition: newPositionAtLineStart(in.LastLine()),
- })
- }
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_index_key_number_limit.go b/backend/plugin/advisor/pg/advisor_index_key_number_limit.go
deleted file mode 100644
index 608fa9e7fc..0000000000
--- a/backend/plugin/advisor/pg/advisor_index_key_number_limit.go
+++ /dev/null
@@ -1,122 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*IndexKeyNumberLimitAdvisor)(nil)
- _ ast.Visitor = (*indexKeyNumberLimitChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleIndexKeyNumberLimit, &IndexKeyNumberLimitAdvisor{})
-}
-
-// IndexKeyNumberLimitAdvisor is the advisor checking for index key number limit.
-type IndexKeyNumberLimitAdvisor struct {
-}
-
-// Check checks for index key number limit.
-func (*IndexKeyNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &indexKeyNumberLimitChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- max: payload.Number,
- }
-
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type indexKeyNumberLimitChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- max int
-}
-
-func (checker *indexKeyNumberLimitChecker) getMetaDataList(in ast.Node) []*indexMetaData {
- var res []*indexMetaData
-
- switch node := in.(type) {
- case *ast.CreateIndexStmt:
- if checker.max > 0 && len(node.Index.KeyList) > checker.max {
- res = append(res, &indexMetaData{
- indexName: node.Index.Name,
- tableName: node.Index.Table.Name,
- line: node.LastLine(),
- })
- }
- case *ast.CreateTableStmt:
- for _, constraint := range node.ConstraintList {
- if checker.max > 0 && indexKeyNumber(constraint) > checker.max {
- res = append(res, &indexMetaData{
- indexName: constraint.Name,
- tableName: node.Name.Name,
- line: constraint.LastLine(),
- })
- }
- }
- case *ast.AddConstraintStmt:
- if checker.max > 0 && indexKeyNumber(node.Constraint) > checker.max {
- res = append(res, &indexMetaData{
- indexName: node.Constraint.Name,
- tableName: node.Table.Name,
- line: node.LastLine(),
- })
- }
- }
-
- return res
-}
-
-func (checker *indexKeyNumberLimitChecker) Visit(node ast.Node) ast.Visitor {
- indexDataList := checker.getMetaDataList(node)
-
- for _, index := range indexDataList {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.IndexKeyNumberExceedsLimit.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The number of keys of index %q in table %q should be not greater than %d", index.indexName, index.tableName, checker.max),
- StartPosition: newPositionAtLineStart(index.line),
- })
- }
- return checker
-}
-
-func indexKeyNumber(constraint *ast.ConstraintDef) int {
- switch constraint.Type {
- case ast.ConstraintTypePrimary,
- ast.ConstraintTypeUnique,
- ast.ConstraintTypeForeign:
- return len(constraint.KeyList)
- default:
- return 0
- }
-}
diff --git a/backend/plugin/advisor/pg/advisor_index_no_duplicate_column.go b/backend/plugin/advisor/pg/advisor_index_no_duplicate_column.go
deleted file mode 100644
index 177db7125f..0000000000
--- a/backend/plugin/advisor/pg/advisor_index_no_duplicate_column.go
+++ /dev/null
@@ -1,160 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleIndexNoDuplicateColumn, &IndexNoDuplicateColumnAdvisor{})
-}
-
-// IndexNoDuplicateColumnAdvisor is the advisor checking for no duplicate columns in index.
-type IndexNoDuplicateColumnAdvisor struct {
-}
-
-// Check checks for no duplicate columns in index.
-func (*IndexNoDuplicateColumnAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &indexNoDuplicateColumnChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type indexNoDuplicateColumnChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
-
-type duplicateColumn struct {
- table string
- index string
- column string
- constraintType string
- line int
-}
-
-func (checker *indexNoDuplicateColumnChecker) Visit(node ast.Node) ast.Visitor {
- var columnList []duplicateColumn
- switch node := node.(type) {
- case *ast.CreateTableStmt:
- for _, constraint := range node.ConstraintList {
- switch constraint.Type {
- case ast.ConstraintTypePrimary,
- ast.ConstraintTypeForeign,
- ast.ConstraintTypePrimaryUsingIndex,
- ast.ConstraintTypeUnique,
- ast.ConstraintTypeUniqueUsingIndex:
- if column, duplicate := hasDuplicateColumn(constraint.KeyList); duplicate {
- columnList = append(columnList, duplicateColumn{
- table: node.Name.Name,
- index: constraint.Name,
- column: column,
- constraintType: contraintsTypeToString(constraint.Type),
- line: checker.line,
- })
- }
- default:
- // Other constraint types are not checked for duplicate columns
- }
- }
- case *ast.CreateIndexStmt:
- if column, duplicate := hasDuplicateColumn(node.Index.GetKeyNameList()); duplicate {
- columnList = append(columnList, duplicateColumn{
- table: node.Index.Table.Name,
- index: node.Index.Name,
- column: column,
- constraintType: "INDEX",
- line: checker.line,
- })
- }
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- switch cmd := item.(type) {
- case *ast.AddConstraintStmt:
- switch cmd.Constraint.Type {
- case ast.ConstraintTypePrimary,
- ast.ConstraintTypeForeign,
- ast.ConstraintTypePrimaryUsingIndex,
- ast.ConstraintTypeUnique,
- ast.ConstraintTypeUniqueUsingIndex:
- if column, duplicate := hasDuplicateColumn(cmd.Constraint.KeyList); duplicate {
- columnList = append(columnList, duplicateColumn{
- table: cmd.Table.Name,
- index: cmd.Constraint.Name,
- column: column,
- constraintType: contraintsTypeToString(cmd.Constraint.Type),
- line: checker.line,
- })
- }
- default:
- // Other constraint types are not checked for duplicate columns
- }
- default:
- continue
- }
- }
- }
-
- for _, column := range columnList {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.DuplicateColumnInIndex.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("%s \"%s\" has duplicate column \"%s\".\"%s\"", column.constraintType, column.index, column.table, column.column),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
-
- return checker
-}
-
-func hasDuplicateColumn(keyList []string) (string, bool) {
- existMap := make(map[string]bool)
- for _, key := range keyList {
- if _, isExist := existMap[key]; isExist {
- return key, true
- }
- existMap[key] = true
- }
- return "", false
-}
-
-func contraintsTypeToString(constrainType ast.ConstraintType) string {
- switch constrainType {
- case ast.ConstraintTypePrimary, ast.ConstraintTypePrimaryUsingIndex:
- return "PRIMARY KEY"
- case ast.ConstraintTypeUnique, ast.ConstraintTypeUniqueUsingIndex:
- return "UNIQUE KEY"
- case ast.ConstraintTypeForeign:
- return "FOREIGN KEY"
- default:
- return "INDEX"
- }
-}
diff --git a/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go b/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go
deleted file mode 100644
index c51310e0d0..0000000000
--- a/backend/plugin/advisor/pg/advisor_index_primary_key_type_allowlist.go
+++ /dev/null
@@ -1,127 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "log/slog"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- pgrawparser "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*IndexPrimaryKeyTypeAllowlistAdvisor)(nil)
- _ ast.Visitor = (*indexPrimaryKeyTypeAllowlistChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleIndexPrimaryKeyTypeAllowlist, &IndexPrimaryKeyTypeAllowlistAdvisor{})
-}
-
-// IndexPrimaryKeyTypeAllowlistAdvisor is the advisor checking for primary key type allowlist.
-type IndexPrimaryKeyTypeAllowlistAdvisor struct {
-}
-
-// Check checks for primary key type allowlist.
-func (*IndexPrimaryKeyTypeAllowlistAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalStringArrayTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &indexPrimaryKeyTypeAllowlistChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- allowlist: payload.List,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type indexPrimaryKeyTypeAllowlistChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- allowlist []string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *indexPrimaryKeyTypeAllowlistChecker) Visit(in ast.Node) ast.Visitor {
- var columnList []*ast.ColumnDef
- columnMap := make(map[string]*ast.ColumnDef)
- if node, ok := in.(*ast.CreateTableStmt); ok {
- for _, column := range node.ColumnList {
- columnMap[column.ColumnName] = column
- if isPKColumn(column) {
- columnList = append(columnList, column)
- }
- }
- for _, constraint := range node.ConstraintList {
- if constraint.Type == ast.ConstraintTypePrimary {
- for _, key := range constraint.KeyList {
- if column, exists := columnMap[key]; exists {
- columnList = append(columnList, column)
- }
- }
- }
- }
- }
-
- for _, column := range columnList {
- if !allowType(checker.allowlist, column.Type) {
- typeText, err := pgrawparser.Deparse(pgrawparser.DeparseContext{}, column.Type)
- if err != nil {
- slog.Warn("Failed to deparse the PostgreSQL data type",
- slog.String("columnName", column.ColumnName),
- slog.String("originalSQL", in.Text()))
- typeText = ""
- }
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.IndexPKType.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`The column "%s" is one of the primary key, but its type "%s" is not in allowlist`, column.ColumnName, typeText),
- StartPosition: newPositionAtLineStart(column.LastLine()),
- })
- }
- }
-
- return checker
-}
-
-func allowType(allowlist []string, columnType ast.DataType) bool {
- for _, tp := range allowlist {
- if columnType.EquivalentType(tp) {
- return true
- }
- }
- return false
-}
-
-func isPKColumn(column *ast.ColumnDef) bool {
- for _, constraint := range column.ConstraintList {
- if constraint.Type == ast.ConstraintTypePrimary {
- return true
- }
- }
-
- return false
-}
diff --git a/backend/plugin/advisor/pg/advisor_index_total_number_limit.go b/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
deleted file mode 100644
index 12e67e22c8..0000000000
--- a/backend/plugin/advisor/pg/advisor_index_total_number_limit.go
+++ /dev/null
@@ -1,175 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "slices"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*IndexTotalNumberLimitAdvisor)(nil)
- _ ast.Visitor = (*indexTotalNumberLimitChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleIndexTotalNumberLimit, &IndexTotalNumberLimitAdvisor{})
-}
-
-// IndexTotalNumberLimitAdvisor is the advisor checking for index total number limit.
-type IndexTotalNumberLimitAdvisor struct {
-}
-
-// Check checks for index total number limit.
-func (*IndexTotalNumberLimitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &indexTotalNumberLimitChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- max: payload.Number,
- catalog: checkCtx.Catalog,
- tableLine: make(tableLineMap),
- }
-
- if checker.catalog.Final.Usable() {
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
- }
-
- return checker.generateAdvice(), nil
-}
-
-type tableLine struct {
- schema string
- table string
- line int
-}
-
-type tableLineMap map[string]tableLine
-
-func (m tableLineMap) set(schema string, table string, line int) {
- if schema == "" {
- schema = "public"
- }
- m[fmt.Sprintf("%q.%q", schema, table)] = tableLine{
- schema: schema,
- table: table,
- line: line,
- }
-}
-
-type indexTotalNumberLimitChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- max int
- catalog *catalog.Finder
- tableLine tableLineMap
-}
-
-func (checker *indexTotalNumberLimitChecker) generateAdvice() []*storepb.Advice {
- var tableList []tableLine
- for _, table := range checker.tableLine {
- tableList = append(tableList, table)
- }
- slices.SortFunc(tableList, func(i, j tableLine) int {
- if i.line < j.line {
- return -1
- }
- if i.line > j.line {
- return 1
- }
- return 0
- })
-
- for _, table := range tableList {
- tableInfo := checker.catalog.Final.FindTable(&catalog.TableFind{
- SchemaName: table.schema,
- TableName: table.table,
- })
- if tableInfo != nil && tableInfo.CountIndex() > checker.max {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.IndexCountExceedsLimit.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The count of index in table %q.%q should be no more than %d, but found %d", table.schema, table.table, checker.max, tableInfo.CountIndex()),
- StartPosition: newPositionAtLineStart(table.line),
- })
- }
- }
-
- return checker.adviceList
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *indexTotalNumberLimitChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- checker.tableLine.set(node.Name.Schema, node.Name.Name, node.LastLine())
- case *ast.AlterTableStmt:
- for _, item := range node.AlterItemList {
- switch itemNode := item.(type) {
- case *ast.AddColumnListStmt:
- for _, column := range itemNode.ColumnList {
- if createIndex(column) {
- checker.tableLine.set(node.Table.Schema, node.Table.Name, node.LastLine())
- break
- }
- }
- case *ast.AddConstraintStmt:
- if createIndex(itemNode.Constraint) {
- checker.tableLine.set(node.Table.Schema, node.Table.Name, node.LastLine())
- break
- }
- }
- }
- case *ast.CreateIndexStmt:
- checker.tableLine.set(node.Index.Table.Schema, node.Index.Table.Name, node.LastLine())
- }
-
- return checker
-}
-
-func createIndex(in ast.Node) bool {
- switch node := in.(type) {
- case *ast.ColumnDef:
- for _, constraint := range node.ConstraintList {
- switch constraint.Type {
- case ast.ConstraintTypePrimary, ast.ConstraintTypeUnique:
- return true
- default:
- // Other constraint types don't count as indexes
- }
- }
- case *ast.ConstraintDef:
- switch node.Type {
- case ast.ConstraintTypePrimary, ast.ConstraintTypeUnique:
- return true
- default:
- // Other constraint types don't count as indexes
- return false
- }
- }
- return false
-}
diff --git a/backend/plugin/advisor/pg/advisor_insert_disallow_order_by_rand.go b/backend/plugin/advisor/pg/advisor_insert_disallow_order_by_rand.go
deleted file mode 100644
index a60d026cf6..0000000000
--- a/backend/plugin/advisor/pg/advisor_insert_disallow_order_by_rand.go
+++ /dev/null
@@ -1,85 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*InsertDisallowOrderByRandAdvisor)(nil)
- _ ast.Visitor = (*insertDisallowOrderByRandChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementInsertDisallowOrderByRand, &InsertDisallowOrderByRandAdvisor{})
-}
-
-// InsertDisallowOrderByRandAdvisor is the advisor checking for to disallow order by rand in INSERT statements.
-type InsertDisallowOrderByRandAdvisor struct {
-}
-
-// Check checks for to disallow order by rand in INSERT statements.
-func (*InsertDisallowOrderByRandAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &insertDisallowOrderByRandChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.text = advisor.NormalizeStatement(stmt.Text())
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type insertDisallowOrderByRandChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *insertDisallowOrderByRandChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
- if insert, ok := in.(*ast.InsertStmt); ok && insert.Select != nil {
- for _, item := range insert.Select.OrderByClause {
- if strings.Contains(item.Expression.Text(), "random()") ||
- strings.Contains(item.Expression.Text(), "random_between()") {
- code = advisor.InsertUseOrderByRand
- break
- }
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The INSERT statement uses ORDER BY random() or random_between(), related statement \"%s\"", checker.text),
- StartPosition: newPositionAtLineStart(in.LastLine()),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_insert_must_specify_column.go b/backend/plugin/advisor/pg/advisor_insert_must_specify_column.go
deleted file mode 100644
index cc6858a951..0000000000
--- a/backend/plugin/advisor/pg/advisor_insert_must_specify_column.go
+++ /dev/null
@@ -1,73 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*InsertMustSpecifyColumnAdvisor)(nil)
- _ ast.Visitor = (*insertMustSpecifyColumnChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementInsertMustSpecifyColumn, &InsertMustSpecifyColumnAdvisor{})
-}
-
-// InsertMustSpecifyColumnAdvisor is the advisor checking for to enforce column specified.
-type InsertMustSpecifyColumnAdvisor struct {
-}
-
-// Check checks for to enforce column specified.
-func (*InsertMustSpecifyColumnAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &insertMustSpecifyColumnChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.text = advisor.NormalizeStatement(stmt.Text())
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type insertMustSpecifyColumnChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *insertMustSpecifyColumnChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.InsertStmt); ok && len(node.ColumnList) == 0 {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.InsertNotSpecifyColumn.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The INSERT statement must specify columns but \"%s\" does not", checker.text),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_insert_row_limit.go b/backend/plugin/advisor/pg/advisor_insert_row_limit.go
deleted file mode 100644
index 748d34ea8a..0000000000
--- a/backend/plugin/advisor/pg/advisor_insert_row_limit.go
+++ /dev/null
@@ -1,188 +0,0 @@
-package pg
-
-import (
- "context"
- "database/sql"
- "fmt"
- "regexp"
- "strconv"
-
- "github.com/pkg/errors"
-
- "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/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*InsertRowLimitAdvisor)(nil)
- _ ast.Visitor = (*insertRowLimitChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementInsertRowLimit, &InsertRowLimitAdvisor{})
-}
-
-// InsertRowLimitAdvisor is the advisor checking for to limit INSERT rows.
-type InsertRowLimitAdvisor struct {
-}
-
-// Check checks for the WHERE clause requirement.
-func (*InsertRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &insertRowLimitChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- maxRow: payload.Number,
- driver: checkCtx.Driver,
- ctx: ctx,
- UsePostgresDatabaseOwner: checkCtx.UsePostgresDatabaseOwner,
- }
-
- if payload.Number > 0 {
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- if checker.explainCount >= common.MaximumLintExplainSize {
- break
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-type insertRowLimitChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
- maxRow int
- driver *sql.DB
- ctx context.Context
- explainCount int
- setRoles []string
- UsePostgresDatabaseOwner bool
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *insertRowLimitChecker) Visit(node ast.Node) ast.Visitor {
- code := advisor.Ok
- rows := int64(0)
-
- switch n := node.(type) {
- case *ast.VariableSetStmt:
- if n.Name == "role" {
- checker.setRoles = append(checker.setRoles, node.Text())
- }
- case *ast.InsertStmt:
- if len(n.ValueList) > 0 {
- // For INSERT INTO ... VALUES ... statements, use parser only.
- if len(n.ValueList) > checker.maxRow {
- code = advisor.InsertTooManyRows
- rows = int64(len(n.ValueList))
- }
- } else if checker.driver != nil {
- // For INSERT INTO ... SELECT statements, use EXPLAIN.
- checker.explainCount++
- res, err := advisor.Query(checker.ctx, advisor.QueryContext{
- UsePostgresDatabaseOwner: checker.UsePostgresDatabaseOwner,
- PreExecutions: checker.setRoles,
- }, checker.driver, storepb.Engine_POSTGRES, fmt.Sprintf("EXPLAIN %s", node.Text()))
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.InsertTooManyRows.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" dry runs failed: %s", checker.text, err.Error()),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- } else {
- rowCount, err := getAffectedRows(res)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("failed to get row count for \"%s\": %s", checker.text, err.Error()),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- } else if rowCount > int64(checker.maxRow) {
- code = advisor.InsertTooManyRows
- rows = rowCount
- }
- }
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The statement \"%s\" inserts %d rows. The count exceeds %d.", checker.text, rows, checker.maxRow),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- return checker
-}
-
-func getAffectedRows(res []any) (int64, error) {
- // the res struct is []any{columnName, columnTable, rowDataList}
- if len(res) != 3 {
- return 0, errors.Errorf("expected 3 but got %d", len(res))
- }
- rowList, ok := res[2].([]any)
- if !ok {
- return 0, errors.Errorf("expected []any but got %t", res[2])
- }
- // test-bb=# EXPLAIN INSERT INTO t SELECT * FROM t;
- // QUERY PLAN
- // -------------------------------------------------------------
- // Insert on t (cost=0.00..1.03 rows=0 width=0)
- // -> Seq Scan on t t_1 (cost=0.00..1.03 rows=3 width=520)
- // (2 rows)
- if len(rowList) < 2 {
- return 0, errors.Errorf("not found any data")
- }
- // We need the row 2.
- rowTwo, ok := rowList[1].([]any)
- if !ok {
- return 0, errors.Errorf("expected []any but got %t", rowList[0])
- }
- // PostgreSQL EXPLAIN statement result has one column.
- if len(rowTwo) != 1 {
- return 0, errors.Errorf("expected one but got %d", len(rowTwo))
- }
- // Get the string value.
- text, ok := rowTwo[0].(string)
- if !ok {
- return 0, errors.Errorf("expected string but got %t", rowTwo[0])
- }
-
- rowsRegexp := regexp.MustCompile("rows=([0-9]+)")
- matches := rowsRegexp.FindStringSubmatch(text)
- if len(matches) != 2 {
- return 0, errors.Errorf("failed to find rows in %q", text)
- }
- value, err := strconv.ParseInt(matches[1], 10, 64)
- if err != nil {
- return 0, errors.Errorf("failed to get integer from %q", matches[1])
- }
- return value, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_migration_compatibility.go b/backend/plugin/advisor/pg/advisor_migration_compatibility.go
deleted file mode 100644
index b26904cdcb..0000000000
--- a/backend/plugin/advisor/pg/advisor_migration_compatibility.go
+++ /dev/null
@@ -1,130 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*CompatibilityAdvisor)(nil)
- _ ast.Visitor = (*compatibilityChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleSchemaBackwardCompatibility, &CompatibilityAdvisor{})
-}
-
-// CompatibilityAdvisor is the advisor checking for schema backward compatibility.
-type CompatibilityAdvisor struct {
-}
-
-// Check checks schema backward compatibility.
-func (*CompatibilityAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &compatibilityChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type compatibilityChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- lastCreateTable string
-}
-
-func (checker *compatibilityChecker) Visit(node ast.Node) ast.Visitor {
- code := advisor.Ok
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- checker.lastCreateTable = n.Name.Name
- // DROP DATABASE
- case *ast.DropDatabaseStmt:
- code = advisor.CompatibilityDropDatabase
- // RENAME TABLE/VIEW
- case *ast.RenameTableStmt:
- code = advisor.CompatibilityRenameTable
- // DROP TABLE/VIEW
- case *ast.DropTableStmt:
- code = advisor.CompatibilityDropTable
- // ALTER TABLE RENAME COLUMN
- case *ast.RenameColumnStmt:
- if checker.lastCreateTable != n.Table.Name {
- code = advisor.CompatibilityRenameColumn
- }
- // ALTER TABLE DROP COLUMN
- case *ast.DropColumnStmt:
- if checker.lastCreateTable != n.Table.Name {
- code = advisor.CompatibilityDropColumn
- }
- case *ast.AddConstraintStmt:
- if checker.lastCreateTable != n.Table.Name {
- switch n.Constraint.Type {
- // ADD PRIMARY KEY/ ADD PRIMARY KEY USING INDEX
- case ast.ConstraintTypePrimary, ast.ConstraintTypePrimaryUsingIndex:
- code = advisor.CompatibilityAddPrimaryKey
- // ADD UNIQUE CONSTRAINT
- case ast.ConstraintTypeUnique:
- // ConstraintTypeUniqueUsingIndex doesn't add a new constraint or unique index.
- code = advisor.CompatibilityAddUniqueKey
- // ADD FOREIGIN KEY
- case ast.ConstraintTypeForeign:
- code = advisor.CompatibilityAddForeignKey
- // ADD CHECK
- case ast.ConstraintTypeCheck:
- if !n.Constraint.SkipValidation {
- code = advisor.CompatibilityAddCheck
- }
- default:
- // Other constraint types
- }
- }
- // ALTER TABLE ALTER COLUMN TYPE
- case *ast.AlterColumnTypeStmt:
- if checker.lastCreateTable != n.Table.Name {
- code = advisor.CompatibilityAlterColumn
- }
- // CREATE UNIQUE INDEX
- case *ast.CreateIndexStmt:
- if checker.lastCreateTable != n.Index.Table.Name {
- if n.Index.Unique {
- code = advisor.CompatibilityAddUniqueKey
- }
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" may cause incompatibility with the existing data and code", checker.text),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_column.go b/backend/plugin/advisor/pg/advisor_naming_column.go
deleted file mode 100644
index 99a6a43e53..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_column.go
+++ /dev/null
@@ -1,126 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "regexp"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingColumnConventionAdvisor)(nil)
- _ ast.Visitor = (*namingColumnConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleColumnNaming, &NamingColumnConventionAdvisor{})
-}
-
-// NamingColumnConventionAdvisor is the advisor checking for column convention.
-type NamingColumnConventionAdvisor struct {
-}
-
-// Check checks for column naming convention.
-func (*NamingColumnConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &namingColumnConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- }
-
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type namingColumnConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format *regexp.Regexp
- maxLength int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *namingColumnConventionChecker) Visit(node ast.Node) ast.Visitor {
- type columnData struct {
- name string
- line int
- }
- var columnList []columnData
- var tableName string
-
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- tableName = n.Name.Name
- for _, col := range n.ColumnList {
- columnList = append(columnList, columnData{
- name: col.ColumnName,
- line: col.LastLine(),
- })
- }
- // ALTER TABLE ADD COLUMN
- case *ast.AddColumnListStmt:
- tableName = n.Table.Name
- for _, col := range n.ColumnList {
- columnList = append(columnList, columnData{
- name: col.ColumnName,
- line: n.LastLine(),
- })
- }
- // ALTER TABLE RENAME COLUMN
- case *ast.RenameColumnStmt:
- tableName = n.Table.Name
- columnList = append(columnList, columnData{
- name: n.NewName,
- line: n.LastLine(),
- })
- }
-
- for _, column := range columnList {
- if !checker.format.MatchString(column.name) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingColumnConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\".\"%s\" mismatches column naming convention, naming format should be %q", tableName, column.name, checker.format),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
-
- if checker.maxLength > 0 && len(column.name) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingColumnConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\".\"%s\" mismatches column naming convention, its length should be within %d characters", tableName, column.name, checker.maxLength),
- StartPosition: newPositionAtLineStart(column.line),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go
deleted file mode 100644
index e7c1b91fd2..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_foreign_key_convention.go
+++ /dev/null
@@ -1,181 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "regexp"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingFKConventionAdvisor)(nil)
- _ ast.Visitor = (*namingFKConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleFKNaming, &NamingFKConventionAdvisor{})
-}
-
-// NamingFKConventionAdvisor is the advisor checking for foreign key naming convention.
-type NamingFKConventionAdvisor struct {
-}
-
-// Check checks for foreign key naming convention.
-func (*NamingFKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- root, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(advisor.SQLReviewRuleType(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &namingFKConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- templateList: templateList,
- }
-
- for _, stmtNode := range root {
- ast.Walk(checker, stmtNode)
- }
-
- return checker.adviceList, nil
-}
-
-type namingFKConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format string
- maxLength int
- templateList []string
-}
-
-type indexMetaData struct {
- indexName string
- tableName string
- line int
- metaData map[string]string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *namingFKConventionChecker) Visit(in ast.Node) ast.Visitor {
- indexDataList := checker.getMetaDataList(in)
-
- for _, indexData := range indexDataList {
- regex, err := getTemplateRegexp(checker.format, checker.templateList, indexData.metaData)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: "Internal error for foreign key naming convention rule",
- Content: fmt.Sprintf("%q meet internal error %q", in.Text(), err.Error()),
- })
- continue
- }
- if !regex.MatchString(indexData.indexName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingFKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Foreign key in table "%s" mismatches the naming convention, expect %q but found "%s"`, indexData.tableName, regex, indexData.indexName),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- if checker.maxLength > 0 && len(indexData.indexName) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingFKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Foreign key "%s" in table "%s" mismatches the naming convention, its length should be within %d characters`, indexData.indexName, indexData.tableName, checker.maxLength),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- }
-
- return checker
-}
-
-// getMetaDataList returns the list of foreign key with metadata.
-func (*namingFKConventionChecker) getMetaDataList(in ast.Node) []*indexMetaData {
- var res []*indexMetaData
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, constraint := range node.ConstraintList {
- if metadata := getForeignKeyMetadata(constraint, node.Name.Name, constraint.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := getForeignKeyMetadata(constraint, node.Name.Name, column.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- case *ast.AddConstraintStmt:
- constraint := node.Constraint
- if metadata := getForeignKeyMetadata(constraint, node.Table.Name, node.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- case *ast.AddColumnListStmt:
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := getForeignKeyMetadata(constraint, node.Table.Name, node.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- }
- return res
-}
-
-// getForeignKeyMetadata returns index metadata of a foreign key constraint, nil if other constraints.
-func getForeignKeyMetadata(constraint *ast.ConstraintDef, tableName string, line int) *indexMetaData {
- if constraint.Type == ast.ConstraintTypeForeign {
- referencingColumnList := constraint.KeyList
- referencedColumnList := constraint.Foreign.ColumnList
-
- metaData := map[string]string{
- advisor.ReferencingTableNameTemplateToken: tableName,
- advisor.ReferencingColumnNameTemplateToken: strings.Join(referencingColumnList, "_"),
- advisor.ReferencedTableNameTemplateToken: constraint.Foreign.Table.Name,
- advisor.ReferencedColumnNameTemplateToken: strings.Join(referencedColumnList, "_"),
- }
-
- return &indexMetaData{
- indexName: constraint.Name,
- tableName: tableName,
- line: line,
- metaData: metaData,
- }
- }
- return nil
-}
-
-// getTemplateRegexp formats the template as regex.
-func getTemplateRegexp(template string, templateList []string, tokens map[string]string) (*regexp.Regexp, error) {
- for _, key := range templateList {
- if token, ok := tokens[key]; ok {
- template = strings.ReplaceAll(template, key, token)
- }
- }
-
- return regexp.Compile(template)
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_fully_qualified.go b/backend/plugin/advisor/pg/advisor_naming_fully_qualified.go
deleted file mode 100644
index fb255df844..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_fully_qualified.go
+++ /dev/null
@@ -1,338 +0,0 @@
-package pg
-
-import (
- "context"
- "encoding/json"
- "fmt"
- "regexp"
- "strings"
-
- pgquery "github.com/pganalyze/pg_query_go/v6"
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/base"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleFullyQualifiedObjectName, &FullyQualifiedObjectNameAdvisor{})
-}
-
-type FullyQualifiedObjectNameAdvisor struct{}
-
-type FullyQualifiedObjectNameChecker struct {
- adviceList []*storepb.Advice
- status storepb.Advice_Status
- title string
- line int
- isSelectStmt bool
-}
-
-// Visit implements ast.Visitor.
-func (checker *FullyQualifiedObjectNameChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- // Create statement.
- case *ast.CreateTableStmt:
- if node.Name != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Name)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- case *ast.CreateSequenceStmt:
- if node.SequenceDef.SequenceName != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.SequenceDef.SequenceName)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- case *ast.CreateTriggerStmt:
- if node.Trigger != nil && node.Trigger.Table != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Trigger.Table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- case *ast.CreateIndexStmt:
- if node.Index != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Index)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
-
- // Drop statement.
- case *ast.DropSequenceStmt:
- if node.SequenceNameList != nil {
- for _, seqName := range node.SequenceNameList {
- fullyQualifiedName := getFullyQualiufiedObjectName(seqName)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- }
- case *ast.DropTableStmt:
- if node.TableList != nil {
- for _, table := range node.TableList {
- fullyQualifiedName := getFullyQualiufiedObjectName(table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- }
- case *ast.DropIndexStmt:
- if node.IndexList != nil {
- for _, index := range node.IndexList {
- fullyQualifiedName := getFullyQualiufiedObjectName(index)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- }
- case *ast.DropTriggerStmt:
- if node.Trigger != nil && node.Trigger.Table != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Trigger.Table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
-
- // Alter statement.
- case *ast.AlterTableStmt:
- if node.Table != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
- case *ast.AlterSequenceStmt:
- if node.Name != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Name)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
-
- // Insert statement.
- case *ast.InsertStmt:
- if node.Table != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
-
- // Select statement.
- case *ast.SelectStmt:
- checker.isSelectStmt = true
-
- // Update statement.
- case *ast.UpdateStmt:
- if node.Table != nil {
- fullyQualifiedName := getFullyQualiufiedObjectName(node.Table)
- checker.appendAdviceByObjName(fullyQualifiedName)
- }
-
- // TODO(tommy): check whether this is needed.
- // Comment statement.
- case *ast.CommentStmt:
- default:
- }
-
- return checker
-}
-
-var (
- _ advisor.Advisor = (*FullyQualifiedObjectNameAdvisor)(nil)
- _ ast.Visitor = (*FullyQualifiedObjectNameChecker)(nil)
-)
-
-func (*FullyQualifiedObjectNameAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- checker := &FullyQualifiedObjectNameChecker{}
- status, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker.status = status
- checker.title = checkCtx.Rule.Type
-
- nodes, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- for _, node := range nodes {
- checker.line = node.LastLine()
- ast.Walk(checker, node)
- // Dive in again for the object names in the subquery if it's a select statement.
- if checker.isSelectStmt {
- if checkCtx.DBSchema == nil {
- continue
- }
- for _, tableName := range findAllTables(node.Text(), checkCtx.DBSchema) {
- checker.appendAdviceByObjName(tableName.String())
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-func (checker *FullyQualifiedObjectNameChecker) appendAdviceByObjName(objName string) {
- if objName == "" {
- return
- }
- re := regexp.MustCompile(`.+\..+`)
- if !re.MatchString(objName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.status,
- Code: advisor.NamingNotFullyQualifiedName,
- Title: checker.title,
- Content: fmt.Sprintf("unqualified object name: '%s'", objName),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
-}
-
-func getFullyQualiufiedObjectName(nodeDef ast.Node) string {
- sb := strings.Builder{}
- switch def := nodeDef.(type) {
- case *ast.TableDef:
- if def.Database != "" {
- if _, err := sb.WriteString(def.Database); err != nil {
- return ""
- }
- if _, err := sb.WriteRune('.'); err != nil {
- return ""
- }
- }
- if def.Schema != "" {
- if _, err := sb.WriteString(def.Schema); err != nil {
- return ""
- }
- if _, err := sb.WriteRune('.'); err != nil {
- return ""
- }
- }
- if _, err := sb.WriteString(def.Name); err != nil {
- return ""
- }
-
- case *ast.IndexDef:
- if def.Table != nil && def.Table.Schema != "" {
- if _, err := sb.WriteString(def.Table.Name); err != nil {
- return ""
- }
- if _, err := sb.WriteRune('.'); err != nil {
- return ""
- }
- }
- if _, err := sb.WriteString(def.Name); err != nil {
- return ""
- }
-
- case *ast.SequenceNameDef:
- if def.Schema != "" {
- if _, err := sb.WriteString(def.Schema); err != nil {
- return ""
- }
- if _, err := sb.WriteRune('.'); err != nil {
- return ""
- }
- }
- if _, err := sb.WriteString(def.Name); err != nil {
- return ""
- }
-
- case *ast.ColumnNameDef:
- if def.Table != nil && def.Table.Name != "" {
- _, _ = sb.WriteString(def.Table.Name)
- if _, err := sb.WriteRune('.'); err != nil {
- return ""
- }
- }
- if _, err := sb.WriteString(def.ColumnName); err != nil {
- return ""
- }
-
- default:
- }
- return sb.String()
-}
-
-// Used for select statement.
-func findAllTables(statement string, schemaMetadata *storepb.DatabaseSchemaMetadata) []base.ColumnResource {
- jsonText, err := pgquery.ParseToJSON(statement)
- if err != nil {
- return nil
- }
-
- var jsonData map[string]any
- if err := json.Unmarshal([]byte(jsonText), &jsonData); err != nil {
- return nil
- }
-
- schemaNameMap := getSchemaNameMapFromPublic(schemaMetadata)
- if schemaNameMap == nil {
- return []base.ColumnResource{}
- }
-
- resourceArray, err := getRangeVarsFromJSONRecursive(jsonData, &schemaNameMap)
- if err != nil {
- return nil
- }
-
- return resourceArray
-}
-
-func getSchemaNameMapFromPublic(schemaMetadata *storepb.DatabaseSchemaMetadata) map[string]bool {
- if schemaMetadata.Schemas == nil {
- return nil
- }
- filterMap := map[string]bool{}
- for _, schema := range schemaMetadata.Schemas {
- // Tables.
- for _, tbl := range schema.Tables {
- filterMap[tbl.Name] = true
- }
- // External Tables.
- for _, tbl := range schema.ExternalTables {
- filterMap[tbl.Name] = true
- }
- }
- return filterMap
-}
-
-// get table names from Json.
-func getRangeVarsFromJSONRecursive(jsonData map[string]any, filterMap *map[string]bool) ([]base.ColumnResource, error) {
- var result []base.ColumnResource
- if jsonData["RangeVar"] != nil {
- resource := base.ColumnResource{}
-
- rangeVar, ok := jsonData["RangeVar"].(map[string]any)
- if !ok {
- return nil, errors.Errorf("failed to convert range var")
- }
- if rangeVar["schemaname"] != nil {
- schema, ok := rangeVar["schemaname"].(string)
- if !ok {
- return nil, errors.Errorf("failed to convert schemaname")
- }
- resource.Schema = schema
- }
- if rangeVar["relname"] != nil {
- table, ok := rangeVar["relname"].(string)
- if !ok {
- return nil, errors.Errorf("failed to convert relname")
- }
- resource.Table = table
- }
-
- if _, ok := (*filterMap)[resource.Table]; ok {
- result = append(result, resource)
- }
- }
-
- for _, value := range jsonData {
- switch v := value.(type) {
- case map[string]any:
- resources, err := getRangeVarsFromJSONRecursive(v, filterMap)
- if err != nil {
- return nil, err
- }
- result = append(result, resources...)
- case []any:
- for _, item := range v {
- if m, ok := item.(map[string]any); ok {
- resources, err := getRangeVarsFromJSONRecursive(m, filterMap)
- if err != nil {
- return nil, err
- }
- result = append(result, resources...)
- }
- }
- }
- }
-
- return result, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_index_convention.go b/backend/plugin/advisor/pg/advisor_naming_index_convention.go
deleted file mode 100644
index 882f850935..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_index_convention.go
+++ /dev/null
@@ -1,148 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingIndexConventionAdvisor)(nil)
- _ ast.Visitor = (*namingIndexConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleIDXNaming, &NamingIndexConventionAdvisor{})
-}
-
-// NamingIndexConventionAdvisor is the advisor checking for index naming convention.
-type NamingIndexConventionAdvisor struct {
-}
-
-// Check checks for index naming convention.
-func (*NamingIndexConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(advisor.SQLReviewRuleType(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &namingIndexConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- templateList: templateList,
- catalog: checkCtx.Catalog,
- }
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type namingIndexConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format string
- maxLength int
- templateList []string
- catalog *catalog.Finder
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *namingIndexConventionChecker) Visit(node ast.Node) ast.Visitor {
- indexDataList := checker.getMetaDataList(node)
-
- for _, indexData := range indexDataList {
- regex, err := getTemplateRegexp(checker.format, checker.templateList, indexData.metaData)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: "Internal error for index naming convention rule",
- Content: fmt.Sprintf("%q meet internal error %q", node.Text(), err.Error()),
- })
- continue
- }
- if !regex.MatchString(indexData.indexName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingIndexConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Index in table %q mismatches the naming convention, expect %q but found %q", indexData.tableName, regex, indexData.indexName),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- if checker.maxLength > 0 && len(indexData.indexName) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingIndexConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Index %q in table %q mismatches the naming convention, its length should be within %d characters", indexData.indexName, indexData.tableName, checker.maxLength),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- }
- return checker
-}
-
-func (checker *namingIndexConventionChecker) getMetaDataList(in ast.Node) []*indexMetaData {
- var res []*indexMetaData
-
- switch node := in.(type) {
- case *ast.CreateIndexStmt:
- if !node.Index.Unique {
- var columnList []string
- for _, key := range node.Index.KeyList {
- columnList = append(columnList, key.Key)
- }
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
- advisor.TableNameTemplateToken: node.Index.Table.Name,
- }
- res = append(res, &indexMetaData{
- indexName: node.Index.Name,
- tableName: node.Index.Table.Name,
- metaData: metaData,
- })
- }
- case *ast.RenameIndexStmt:
- tableName, index := checker.catalog.Origin.FindIndex(&catalog.IndexFind{
- SchemaName: normalizeSchemaName(node.Table.Schema),
- TableName: "",
- IndexName: node.IndexName,
- })
- if index != nil && !index.Unique() {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- res = append(res, &indexMetaData{
- indexName: node.NewName,
- tableName: tableName,
- metaData: metaData,
- })
- }
- }
-
- return res
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go
deleted file mode 100644
index f9f405a55c..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_primary_key_convention.go
+++ /dev/null
@@ -1,214 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingPKConventionAdvisor)(nil)
- _ ast.Visitor = (*namingPKConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRulePKNaming, &NamingPKConventionAdvisor{})
-}
-
-// NamingPKConventionAdvisor is the advisor checking for primary key naming convention.
-type NamingPKConventionAdvisor struct {
-}
-
-// Check checks for index naming convention.
-func (*NamingPKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(advisor.SQLReviewRuleType(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &namingPKConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- templateList: templateList,
- catalog: checkCtx.Catalog,
- }
-
- for _, stmtNode := range stmts {
- ast.Walk(checker, stmtNode)
- }
-
- return checker.adviceList, nil
-}
-
-type namingPKConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format string
- maxLength int
- templateList []string
- catalog *catalog.Finder
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *namingPKConventionChecker) Visit(in ast.Node) ast.Visitor {
- indexDataList := checker.getMetaDataList(in)
-
- for _, indexData := range indexDataList {
- regex, err := getTemplateRegexp(checker.format, checker.templateList, indexData.metaData)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: "Internal error for primary key naming convention rule",
- Content: fmt.Sprintf("%q meet internal error %q", in.Text(), err.Error()),
- })
- continue
- }
- if !regex.MatchString(indexData.indexName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingPKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Primary key in table "%s" mismatches the naming convention, expect %q but found "%s"`, indexData.tableName, regex, indexData.indexName),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- if checker.maxLength > 0 && len(indexData.indexName) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingPKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Primary key "%s" in table "%s" mismatches the naming convention, its length should be within %d characters`, indexData.indexName, indexData.tableName, checker.maxLength),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- }
-
- return checker
-}
-
-// getMetaDataList returns the list of primary key with metadata.
-func (checker *namingPKConventionChecker) getMetaDataList(in ast.Node) []*indexMetaData {
- var res []*indexMetaData
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, constraint := range node.ConstraintList {
- if metadata := checker.getPrimaryKeyMetadata(node.Name.Schema, node.Name.Name, constraint, constraint.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := checker.getPrimaryKeyMetadata(node.Name.Schema, node.Name.Name, constraint, column.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- case *ast.AddConstraintStmt:
- constraint := node.Constraint
- if metadata := checker.getPrimaryKeyMetadata(node.Table.Schema, node.Table.Name, constraint, in.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- case *ast.AddColumnListStmt:
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := checker.getPrimaryKeyMetadata(node.Table.Schema, node.Table.Name, constraint, in.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- case *ast.RenameConstraintStmt:
- tableName, index := checker.findIndex(node.Table.Schema, node.Table.Name, node.ConstraintName)
- if index != nil && index.Primary() {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- res = append(res, &indexMetaData{
- indexName: node.NewName,
- tableName: node.Table.Name,
- line: in.LastLine(),
- metaData: metaData,
- })
- }
- case *ast.RenameIndexStmt:
- // "ALTER INDEX name RENAME TO new_name" doesn't take a table name
- tableName, index := checker.findIndex(node.Table.Schema, "", node.IndexName)
- if index != nil && index.Primary() {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- res = append(res, &indexMetaData{
- indexName: node.NewName,
- tableName: tableName,
- line: in.LastLine(),
- metaData: metaData,
- })
- }
- }
- return res
-}
-
-// getPrimaryKeyMetadata returns index metadata of a primary key constraint, nil if other constraints.
-func (checker *namingPKConventionChecker) getPrimaryKeyMetadata(schemaName string, tableName string, constraint *ast.ConstraintDef, line int) *indexMetaData {
- switch constraint.Type {
- case ast.ConstraintTypePrimary:
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(constraint.KeyList, "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- return &indexMetaData{
- indexName: constraint.Name,
- tableName: tableName,
- line: line,
- metaData: metaData,
- }
- case ast.ConstraintTypePrimaryUsingIndex:
- tableName, index := checker.findIndex(schemaName, tableName, constraint.IndexName)
- if index != nil {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- return &indexMetaData{
- indexName: constraint.Name,
- tableName: tableName,
- line: line,
- metaData: metaData,
- }
- }
- default:
- // Not a primary key constraint, return nil
- }
- return nil
-}
-
-// findIndex returns index found in catalogs, nil if not found.
-func (checker *namingPKConventionChecker) findIndex(schemaName string, tableName string, indexName string) (string, *catalog.IndexState) {
- return checker.catalog.Origin.FindIndex(&catalog.IndexFind{
- SchemaName: normalizeSchemaName(schemaName),
- TableName: tableName,
- IndexName: indexName,
- })
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_table.go b/backend/plugin/advisor/pg/advisor_naming_table.go
deleted file mode 100644
index f60d6538cf..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_table.go
+++ /dev/null
@@ -1,101 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "regexp"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingTableConventionAdvisor)(nil)
- _ ast.Visitor = (*namingTableConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableNaming, &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) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, maxLength, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &namingTableConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- }
-
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type namingTableConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format *regexp.Regexp
- maxLength int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *namingTableConventionChecker) Visit(node ast.Node) ast.Visitor {
- var tableNames []string
-
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- tableNames = append(tableNames, n.Name.Name)
- // ALTER TABLE RENAME TABLE
- case *ast.RenameTableStmt:
- tableNames = append(tableNames, n.NewName)
- }
-
- for _, tableName := range tableNames {
- if !checker.format.MatchString(tableName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingTableConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`"%s" mismatches table naming convention, naming format should be %q`, tableName, checker.format),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- if checker.maxLength > 0 && len(tableName) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingTableConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" mismatches table naming convention, its length should be within %d characters", tableName, checker.maxLength),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go b/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go
deleted file mode 100644
index 8c8edce571..0000000000
--- a/backend/plugin/advisor/pg/advisor_naming_unique_key_convention.go
+++ /dev/null
@@ -1,231 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
- "strings"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NamingUKConventionAdvisor)(nil)
- _ ast.Visitor = (*namingUKConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleUKNaming, &NamingUKConventionAdvisor{})
-}
-
-// NamingUKConventionAdvisor is the advisor checking for unique key naming convention.
-type NamingUKConventionAdvisor struct {
-}
-
-// Check checks for unique key naming convention.
-func (*NamingUKConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- root, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, templateList, maxLength, err := advisor.UnmarshalNamingRulePayloadAsTemplate(advisor.SQLReviewRuleType(checkCtx.Rule.Type), checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
-
- checker := &namingUKConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- maxLength: maxLength,
- templateList: templateList,
- catalog: checkCtx.Catalog,
- }
-
- for _, stmtNode := range root {
- ast.Walk(checker, stmtNode)
- }
-
- return checker.adviceList, nil
-}
-
-type namingUKConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format string
- maxLength int
- templateList []string
- catalog *catalog.Finder
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *namingUKConventionChecker) Visit(in ast.Node) ast.Visitor {
- indexDataList := checker.getMetaDataList(in)
-
- for _, indexData := range indexDataList {
- regex, err := getTemplateRegexp(checker.format, checker.templateList, indexData.metaData)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: "Internal error for unique key naming convention rule",
- Content: fmt.Sprintf("%q meet internal error %q", in.Text(), err.Error()),
- })
- continue
- }
- if !regex.MatchString(indexData.indexName) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingUKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Unique key in table "%s" mismatches the naming convention, expect %q but found "%s"`, indexData.tableName, regex, indexData.indexName),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- if checker.maxLength > 0 && len(indexData.indexName) > checker.maxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.NamingUKConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf(`Unique key "%s" in table "%s" mismatches the naming convention, its length should be within %d characters`, indexData.indexName, indexData.tableName, checker.maxLength),
- StartPosition: newPositionAtLineStart(indexData.line),
- })
- }
- }
-
- return checker
-}
-
-// getMetaDataList returns the list of unique key with metadata.
-func (checker *namingUKConventionChecker) getMetaDataList(in ast.Node) []*indexMetaData {
- var res []*indexMetaData
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- for _, constraint := range node.ConstraintList {
- if metadata := checker.getUniqueKeyMetadata(node.Name.Schema, node.Name.Name, constraint, constraint.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := checker.getUniqueKeyMetadata(node.Name.Schema, node.Name.Name, constraint, column.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- case *ast.AddConstraintStmt:
- constraint := node.Constraint
- if metadata := checker.getUniqueKeyMetadata(node.Table.Schema, node.Table.Name, constraint, node.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- case *ast.AddColumnListStmt:
- for _, column := range node.ColumnList {
- for _, constraint := range column.ConstraintList {
- if metadata := checker.getUniqueKeyMetadata(node.Table.Schema, node.Table.Name, constraint, node.LastLine()); metadata != nil {
- res = append(res, metadata)
- }
- }
- }
- case *ast.CreateIndexStmt:
- if node.Index.Unique {
- var columnList []string
- for _, key := range node.Index.KeyList {
- columnList = append(columnList, key.Key)
- }
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(columnList, "_"),
- advisor.TableNameTemplateToken: node.Index.Table.Name,
- }
- res = append(res, &indexMetaData{
- indexName: node.Index.Name,
- tableName: node.Index.Table.Name,
- line: node.LastLine(),
- metaData: metaData,
- })
- }
- case *ast.RenameConstraintStmt:
- tableName, index := checker.findIndex(node.Table.Schema, node.Table.Name, node.ConstraintName)
- if index != nil && index.Unique() && !index.Primary() {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- res = append(res, &indexMetaData{
- indexName: node.NewName,
- tableName: node.Table.Name,
- line: node.LastLine(),
- metaData: metaData,
- })
- }
- case *ast.RenameIndexStmt:
- // "ALTER INDEX name RENAME TO new_name" doesn't take a table name
- tableName, index := checker.findIndex(node.Table.Schema, "", node.IndexName)
- if index != nil && index.Unique() && !index.Primary() {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- res = append(res, &indexMetaData{
- indexName: node.NewName,
- tableName: tableName,
- line: node.LastLine(),
- metaData: metaData,
- })
- }
- }
- return res
-}
-
-// getUniqueKeyMetadata returns index metadata of a unique key constraint, nil if other constraints.
-func (checker *namingUKConventionChecker) getUniqueKeyMetadata(schemaName string, tableName string, constraint *ast.ConstraintDef, line int) *indexMetaData {
- switch constraint.Type {
- case ast.ConstraintTypeUnique:
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(constraint.KeyList, "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- return &indexMetaData{
- indexName: constraint.Name,
- tableName: tableName,
- line: line,
- metaData: metaData,
- }
- case ast.ConstraintTypeUniqueUsingIndex:
- tableName, index := checker.findIndex(schemaName, tableName, constraint.IndexName)
- if index != nil {
- metaData := map[string]string{
- advisor.ColumnListTemplateToken: strings.Join(index.ExpressionList(), "_"),
- advisor.TableNameTemplateToken: tableName,
- }
- return &indexMetaData{
- indexName: constraint.Name,
- tableName: tableName,
- line: line,
- metaData: metaData,
- }
- }
- default:
- // Not a unique constraint type
- }
- return nil
-}
-
-// findIndex returns index found in catalogs, nil if not found.
-func (checker *namingUKConventionChecker) findIndex(schemaName string, tableName string, indexName string) (string, *catalog.IndexState) {
- return checker.catalog.Origin.FindIndex(&catalog.IndexFind{
- SchemaName: normalizeSchemaName(schemaName),
- TableName: tableName,
- IndexName: indexName,
- })
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_add_check_not_valid.go b/backend/plugin/advisor/pg/advisor_statement_add_check_not_valid.go
deleted file mode 100644
index f59b8cbc88..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_add_check_not_valid.go
+++ /dev/null
@@ -1,74 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementAddCheckNotValidAdvisor)(nil)
- _ ast.Visitor = (*statementAddCheckNotValidChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementAddCheckNotValid, &StatementAddCheckNotValidAdvisor{})
-}
-
-// StatementAddCheckNotValidAdvisor is the advisor checking for to add check not valid.
-type StatementAddCheckNotValidAdvisor struct {
-}
-
-// Check checks for to add check not valid.
-func (*StatementAddCheckNotValidAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementAddCheckNotValidChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementAddCheckNotValidChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- line int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementAddCheckNotValidChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.AddConstraintStmt); ok {
- if node.Constraint.Type == ast.ConstraintTypeCheck && !node.Constraint.SkipValidation {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementAddCheckWithValidation.Int32(),
- Title: checker.title,
- Content: "Adding check constraints with validation will block reads and writes. You can add check constraints not valid and then validate separately",
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_add_fk_not_valid.go b/backend/plugin/advisor/pg/advisor_statement_add_fk_not_valid.go
deleted file mode 100644
index f336ce5090..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_add_fk_not_valid.go
+++ /dev/null
@@ -1,74 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementAddFKNotValidAdvisor)(nil)
- _ ast.Visitor = (*statementAddFKNotValidChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementAddFKNotValid, &StatementAddFKNotValidAdvisor{})
-}
-
-// StatementAddFKNotValidAdvisor is the advisor checking for to add check not valid.
-type StatementAddFKNotValidAdvisor struct {
-}
-
-// Check checks for to add check not valid.
-func (*StatementAddFKNotValidAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementAddFKNotValidChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementAddFKNotValidChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- line int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementAddFKNotValidChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.AddConstraintStmt); ok {
- if node.Constraint.Type == ast.ConstraintTypeForeign && !node.Constraint.SkipValidation {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementAddFKWithValidation.Int32(),
- Title: checker.title,
- Content: "Adding foreign keys with validation will block reads and writes. You can add check foreign keys not valid and then validate separately",
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go b/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go
deleted file mode 100644
index 0935c95897..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_affected_row_limit.go
+++ /dev/null
@@ -1,131 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "database/sql"
- "fmt"
-
- "github.com/pkg/errors"
-
- "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/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementAffectedRowLimitAdvisor)(nil)
- _ ast.Visitor = (*statementAffectedRowLimitChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementAffectedRowLimit, &StatementAffectedRowLimitAdvisor{})
-}
-
-// StatementAffectedRowLimitAdvisor is the advisor checking for UPDATE/DELETE affected row limit.
-type StatementAffectedRowLimitAdvisor struct {
-}
-
-// Check checks for UPDATE/DELETE affected row limit.
-func (*StatementAffectedRowLimitAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &statementAffectedRowLimitChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- maxRow: payload.Number,
- ctx: ctx,
- driver: checkCtx.Driver,
- usePostgresDatabaseOwner: checkCtx.UsePostgresDatabaseOwner,
- }
-
- if payload.Number > 0 && checker.driver != nil {
- for _, stmt := range stmtList {
- checker.text = advisor.NormalizeStatement(stmt.Text())
- ast.Walk(checker, stmt)
- if checker.explainCount >= common.MaximumLintExplainSize {
- break
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-type statementAffectedRowLimitChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- text string
- title string
- maxRow int
- driver *sql.DB
- ctx context.Context
- explainCount int
- setRoles []string
- usePostgresDatabaseOwner bool
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementAffectedRowLimitChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
- rows := int64(0)
- switch node := in.(type) {
- case *ast.VariableSetStmt:
- if node.Name == "role" {
- checker.setRoles = append(checker.setRoles, node.Text())
- }
- case *ast.UpdateStmt, *ast.DeleteStmt:
- checker.explainCount++
- res, err := advisor.Query(checker.ctx, advisor.QueryContext{
- UsePostgresDatabaseOwner: checker.usePostgresDatabaseOwner,
- PreExecutions: checker.setRoles,
- }, checker.driver, storepb.Engine_POSTGRES, fmt.Sprintf("EXPLAIN %s", node.Text()))
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.InsertTooManyRows.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" dry runs failed: %s", checker.text, err.Error()),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- } else {
- rowCount, err := getAffectedRows(res)
- if err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.Internal.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("failed to get row count for \"%s\": %s", checker.text, err.Error()),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- } else if rowCount > int64(checker.maxRow) {
- code = advisor.StatementAffectedRowExceedsLimit
- rows = rowCount
- }
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The statement \"%s\" affected %d rows (estimated). The count exceeds %d.", checker.text, rows, checker.maxRow),
- StartPosition: newPositionAtLineStart(in.LastLine()),
- })
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_check_set_role_variable.go b/backend/plugin/advisor/pg/advisor_statement_check_set_role_variable.go
deleted file mode 100644
index 7402056704..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_check_set_role_variable.go
+++ /dev/null
@@ -1,61 +0,0 @@
-package pg
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementCheckSetRoleVariable)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementCheckSetRoleVariable, &StatementCheckSetRoleVariable{})
-}
-
-type StatementCheckSetRoleVariable struct {
-}
-
-func (*StatementCheckSetRoleVariable) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- variableSetStmts := []*ast.VariableSetStmt{}
- for _, stmt := range stmts {
- if n, ok := stmt.(*ast.VariableSetStmt); ok {
- variableSetStmts = append(variableSetStmts, n)
- } else {
- break
- }
- }
- hasSetRole := false
- for _, stmt := range variableSetStmts {
- if stmt.Name == "role" {
- hasSetRole = true
- }
- }
-
- if !hasSetRole {
- return []*storepb.Advice{{
- Status: level,
- Code: advisor.StatementCheckSetRoleVariable.Int32(),
- Title: string(checkCtx.Rule.Type),
- Content: "No SET ROLE statement found.",
- StartPosition: nil,
- }}, nil
- }
-
- return nil, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_create_specify_schema.go b/backend/plugin/advisor/pg/advisor_statement_create_specify_schema.go
deleted file mode 100644
index ff26f3e8a6..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_create_specify_schema.go
+++ /dev/null
@@ -1,117 +0,0 @@
-package pg
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementCreateSpecifySchema)(nil)
- _ ast.Visitor = (*statementCreateSpecifySchemaChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementCreateSpecifySchema, &StatementCreateSpecifySchema{})
-}
-
-type StatementCreateSpecifySchema struct {
-}
-
-func (*StatementCreateSpecifySchema) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementCreateSpecifySchemaChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementCreateSpecifySchemaChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
-}
-
-func (c *statementCreateSpecifySchemaChecker) Visit(node ast.Node) ast.Visitor {
- switch n := node.(type) {
- case *ast.CreateTableStmt:
- if n.Name.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Table schema should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- case *ast.CreateExtensionStmt:
- if n.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Extension schema should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- case *ast.CreateFunctionStmt:
- if n.Function.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Function schema should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- case *ast.CreateIndexStmt:
- if n.Index.Table.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Table schema for index should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- case *ast.CreateSequenceStmt:
- if n.SequenceDef.SequenceName.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Sequence schema should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- case *ast.CreateTriggerStmt:
- if n.Trigger.Table.Schema == "" {
- c.adviceList = append(c.adviceList, &storepb.Advice{
- Status: c.level,
- Code: advisor.StatementCreateWithoutSchemaName.Int32(),
- Title: c.title,
- Content: "Table schema for trigger should be specified.",
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- }
- return c
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_add_column_with_default.go b/backend/plugin/advisor/pg/advisor_statement_disallow_add_column_with_default.go
deleted file mode 100644
index 5e6d0b3a3f..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_add_column_with_default.go
+++ /dev/null
@@ -1,85 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowAddColumnWithDefaultAdvisor)(nil)
- _ ast.Visitor = (*statementDisallowAddColumnWithDefaultChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowAddColumnWithDefault, &StatementDisallowAddColumnWithDefaultAdvisor{})
-}
-
-// StatementDisallowAddColumnWithDefaultAdvisor is the advisor checking for to disallow add column with default.
-type StatementDisallowAddColumnWithDefaultAdvisor struct {
-}
-
-// Check checks for to disallow add column with default.
-func (*StatementDisallowAddColumnWithDefaultAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementDisallowAddColumnWithDefaultChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementDisallowAddColumnWithDefaultChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- line int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementDisallowAddColumnWithDefaultChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.AddColumnListStmt); ok {
- for _, column := range node.ColumnList {
- if setDefault(column) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementAddColumnWithDefault.Int32(),
- Title: checker.title,
- Content: "Adding column with DEFAULT will locked the whole table and rewriting each rows",
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- }
- }
- return checker
-}
-
-func setDefault(column *ast.ColumnDef) bool {
- for _, constraint := range column.ConstraintList {
- if constraint.Type == ast.ConstraintTypeDefault {
- return true
- }
- }
-
- return false
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_add_not_null.go b/backend/plugin/advisor/pg/advisor_statement_disallow_add_not_null.go
deleted file mode 100644
index 933609769d..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_add_not_null.go
+++ /dev/null
@@ -1,73 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowAddNotNullAdvisor)(nil)
- _ ast.Visitor = (*statementDisallowAddNotNullChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowAddNotNull, &StatementDisallowAddNotNullAdvisor{})
-}
-
-// StatementDisallowAddNotNullAdvisor is the advisor checking for to disallow add not null.
-type StatementDisallowAddNotNullAdvisor struct {
-}
-
-// Check checks for to disallow add not null.
-func (*StatementDisallowAddNotNullAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementDisallowAddNotNullChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementDisallowAddNotNullChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- line int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementDisallowAddNotNullChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.SetNotNullStmt); ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementAddNotNull.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Setting NOT NULL will block reads and writes. You can use CHECK (%q IS NOT NULL) instead", node.ColumnName),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_commit.go b/backend/plugin/advisor/pg/advisor_statement_disallow_commit.go
deleted file mode 100644
index fb8c297a02..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_commit.go
+++ /dev/null
@@ -1,71 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowCommitAdvisor)(nil)
- _ ast.Visitor = (*statementDisallowCommitChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowCommit, &StatementDisallowCommitAdvisor{})
-}
-
-// StatementDisallowCommitAdvisor is the advisor checking for to disallow commit.
-type StatementDisallowCommitAdvisor struct {
-}
-
-// Check checks for to disallow commit.
-func (*StatementDisallowCommitAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementDisallowCommitChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementDisallowCommitChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementDisallowCommitChecker) Visit(in ast.Node) ast.Visitor {
- if _, ok := in.(*ast.CommitStmt); ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementDisallowCommit.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Commit is not allowed, related statement: \"%s\"", in.Text()),
- StartPosition: newPositionAtLineStart(in.LastLine()),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_ddl.go b/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_ddl.go
deleted file mode 100644
index add82fd8bd..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_ddl.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowMixInDDLAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowMixInDDL, &StatementDisallowMixInDDLAdvisor{})
-}
-
-// StatementDisallowMixInDDLAdvisor is the advisor checking for disallow mix DDL and DML.
-type StatementDisallowMixInDDLAdvisor struct {
-}
-
-// Check checks for disallow mix DDL and DML.
-func (*StatementDisallowMixInDDLAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- switch checkCtx.ChangeType {
- case storepb.PlanCheckRunConfig_DDL, storepb.PlanCheckRunConfig_SDL, storepb.PlanCheckRunConfig_DDL_GHOST:
- default:
- return nil, nil
- }
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- title := string(checkCtx.Rule.Type)
-
- var adviceList []*storepb.Advice
- for _, stmt := range stmtList {
- if _, ok := stmt.(ast.DMLNode); ok {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Alter schema can only run DDL, \"%s\" is not DDL", stmt.Text()),
- Code: advisor.StatementDisallowMixDDLDML.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
-
- return adviceList, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_dml.go b/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_dml.go
deleted file mode 100644
index 39c74d2537..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_mix_in_dml.go
+++ /dev/null
@@ -1,60 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowMixInDMLAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowMixInDML, &StatementDisallowMixInDMLAdvisor{})
-}
-
-// StatementDisallowMixInDMLAdvisor is the advisor checking for disallow mix DDL and DML.
-type StatementDisallowMixInDMLAdvisor struct {
-}
-
-// Check checks for disallow mix DDL and DML.
-func (*StatementDisallowMixInDMLAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- switch checkCtx.ChangeType {
- case storepb.PlanCheckRunConfig_DML:
- default:
- return nil, nil
- }
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- title := string(checkCtx.Rule.Type)
-
- var adviceList []*storepb.Advice
- for _, stmt := range stmtList {
- if _, ok := stmt.(ast.DDLNode); ok {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Data change can only run DML, \"%s\" is not DML", stmt.Text()),
- Code: advisor.StatementDisallowMixDDLDML.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
-
- return adviceList, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_on_del_cascade.go b/backend/plugin/advisor/pg/advisor_statement_disallow_on_del_cascade.go
deleted file mode 100644
index 64527d9aaa..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_on_del_cascade.go
+++ /dev/null
@@ -1,73 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "encoding/json"
-
- pgquery "github.com/pganalyze/pg_query_go/v6"
- "github.com/pkg/errors"
-
- "github.com/bytebase/bytebase/backend/common"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowOnDelCascadeAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowOnDelCascade, &StatementDisallowOnDelCascadeAdvisor{})
-}
-
-// StatementDisallowOnDelCascadeAdvisor is the advisor checking the disallow cascade.
-type StatementDisallowOnDelCascadeAdvisor struct {
-}
-
-// Check checks for DML dry run.
-func (*StatementDisallowOnDelCascadeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmt := checkCtx.Statements
- if stmt == "" {
- return nil, nil
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- jsonText, err := pgquery.ParseToJSON(stmt)
- if err != nil {
- return nil, errors.Wrapf(err, "failed to parse statement to JSON")
- }
-
- var jsonData map[string]any
- if err := json.Unmarshal([]byte(jsonText), &jsonData); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal JSON")
- }
-
- cascadeLocations := cascadeNumRecursive(jsonData, 0, isOnDelCascade)
- cascadePositions := convertLocationsToPositions(stmt, cascadeLocations)
-
- var adviceList []*storepb.Advice
- for _, p := range cascadePositions {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: string(checkCtx.Rule.Type),
- Content: "The CASCADE option is not permitted for ON DELETE clauses",
- Code: advisor.StatementDisallowCascade.Int32(),
- StartPosition: common.ConvertANTLRPositionToPosition(&common.ANTLRPosition{
- Line: int32(p.line),
- Column: int32(p.column),
- }, checkCtx.Statements),
- })
- }
-
- return adviceList, nil
-}
-
-func isOnDelCascade(json map[string]any) bool {
- return json["fk_del_action"] == "c"
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_disallow_rm_tbl_cascade.go b/backend/plugin/advisor/pg/advisor_statement_disallow_rm_tbl_cascade.go
deleted file mode 100644
index a7acb3b436..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_disallow_rm_tbl_cascade.go
+++ /dev/null
@@ -1,132 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "encoding/json"
-
- pgquery "github.com/pganalyze/pg_query_go/v6"
- "github.com/pkg/errors"
-
- "github.com/bytebase/bytebase/backend/common"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
-)
-
-var (
- _ advisor.Advisor = (*StatementDisallowOnDelCascadeAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDisallowRemoveTblCascade, &StatementDisallowRemoveTblCascadeAdvisor{})
-}
-
-// StatementDisallowRemoveTblCascadeAdvisor is the advisor checking the disallow cascade.
-type StatementDisallowRemoveTblCascadeAdvisor struct {
-}
-
-// Check checks for DML dry run.
-func (*StatementDisallowRemoveTblCascadeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmt := checkCtx.Statements
- if stmt == "" {
- return nil, nil
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- jsonText, err := pgquery.ParseToJSON(stmt)
- if err != nil {
- return nil, errors.Wrapf(err, "failed to parse statement to JSON")
- }
-
- var jsonData map[string]any
- if err := json.Unmarshal([]byte(jsonText), &jsonData); err != nil {
- return nil, errors.Wrapf(err, "failed to unmarshal JSON")
- }
-
- cascadeLocations := cascadeNumRecursive(jsonData, 0, isDropCascade)
- cascadePositions := convertLocationsToPositions(stmt, cascadeLocations)
-
- var adviceList []*storepb.Advice
- for _, p := range cascadePositions {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: string(checkCtx.Rule.Type),
- Content: "The use of CASCADE is not permitted when removing a table",
- Code: advisor.StatementDisallowCascade.Int32(),
- StartPosition: common.ConvertANTLRPositionToPosition(&common.ANTLRPosition{
- Line: int32(p.line),
- Column: int32(p.column),
- }, checkCtx.Statements),
- })
- }
-
- return adviceList, nil
-}
-
-type pos struct {
- line int
- column int
-}
-
-func convertLocationsToPositions(statement string, locations []int) []pos {
- idx := 0
- line := 0
- columnStart := 0
- var positions []pos
- for i, c := range statement {
- if c == '\n' {
- line++
- columnStart = i + 1
- continue
- }
- if idx < len(locations) && i >= locations[idx] {
- positions = append(positions, pos{line, i - columnStart})
- idx++
- }
- }
- for idx < len(locations) {
- positions = append(positions, pos{line, 0})
- idx++
- }
- return positions
-}
-
-func cascadeNumRecursive(jsonData map[string]any, stmtLocation int, checkCondition func(map[string]any) bool) []int {
- if l, ok := jsonData["stmt_location"]; ok {
- if l, ok := l.(float64); ok {
- stmtLocation = int(l)
- }
- }
-
- var cascadeLocations []int
-
- for _, value := range jsonData {
- switch value := value.(type) {
- case map[string]any:
- cascadeLocations = append(cascadeLocations, cascadeNumRecursive(value, stmtLocation, checkCondition)...)
- case []any:
- for _, v := range value {
- mv, ok := v.(map[string]any)
- if !ok {
- continue
- }
- cascadeLocations = append(cascadeLocations, cascadeNumRecursive(mv, stmtLocation, checkCondition)...)
- }
- }
- }
-
- if checkCondition(jsonData) {
- cascadeLocations = append(cascadeLocations, stmtLocation)
- }
-
- return cascadeLocations
-}
-
-func isDropCascade(json map[string]any) bool {
- return json["behavior"] == "DROP_CASCADE"
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_dml_dry_run.go b/backend/plugin/advisor/pg/advisor_statement_dml_dry_run.go
deleted file mode 100644
index cd5b7b458c..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_dml_dry_run.go
+++ /dev/null
@@ -1,97 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "database/sql"
- "fmt"
-
- "github.com/pkg/errors"
-
- "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/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementDmlDryRunAdvisor)(nil)
- _ ast.Visitor = (*statementDmlDryRunChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementDMLDryRun, &StatementDmlDryRunAdvisor{})
-}
-
-// StatementDmlDryRunAdvisor is the advisor checking for DML dry run.
-type StatementDmlDryRunAdvisor struct {
-}
-
-// Check checks for DML dry run.
-func (*StatementDmlDryRunAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementDmlDryRunChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- driver: checkCtx.Driver,
- ctx: ctx,
- useDatabaseOwner: checkCtx.UsePostgresDatabaseOwner,
- }
-
- if checker.driver != nil {
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- if checker.explainCount >= common.MaximumLintExplainSize {
- break
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-type statementDmlDryRunChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- driver *sql.DB
- ctx context.Context
- explainCount int
- setRoles []string
- useDatabaseOwner bool
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementDmlDryRunChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- case *ast.VariableSetStmt:
- if node.Name == "role" {
- checker.setRoles = append(checker.setRoles, node.Text())
- }
- case *ast.InsertStmt, *ast.UpdateStmt, *ast.DeleteStmt:
- checker.explainCount++
- if _, err := advisor.Query(checker.ctx, advisor.QueryContext{
- UsePostgresDatabaseOwner: checker.useDatabaseOwner,
- PreExecutions: checker.setRoles,
- }, checker.driver, storepb.Engine_POSTGRES, fmt.Sprintf("EXPLAIN %s", node.Text())); err != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementDMLDryRunFailed.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" dry runs failed: %s", node.Text(), err.Error()),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go b/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go
deleted file mode 100644
index 25620fe2dc..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_maximum_limit_value.go
+++ /dev/null
@@ -1,81 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementMaximumLimitValueAdvisor)(nil)
- _ ast.Visitor = (*statementMaximumLimitValueChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementMaximumLimitValue, &StatementMaximumLimitValueAdvisor{})
-}
-
-// StatementAddCheckNotValidAdvisor is the advisor checking for to add check not valid.
-type StatementMaximumLimitValueAdvisor struct {
-}
-
-// Check checks for to add check not valid.
-func (*StatementMaximumLimitValueAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalNumberTypeRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &statementMaximumLimitValueChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- limitMaxValue: payload.Number,
- }
-
- for _, stmt := range stmtList {
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type statementMaximumLimitValueChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- line int
- limitMaxValue int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementMaximumLimitValueChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.SelectStmt); ok {
- if node.Limit != nil && int(*node.Limit) > checker.limitMaxValue {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementExceedMaximumLimitValue.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("The limit value %d exceeds the maximum allowed value %d", *node.Limit, checker.limitMaxValue),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_merge_alter_table.go b/backend/plugin/advisor/pg/advisor_statement_merge_alter_table.go
deleted file mode 100644
index abff5f49a7..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_merge_alter_table.go
+++ /dev/null
@@ -1,130 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "slices"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*StatementMergeAlterTableAdvisor)(nil)
- _ ast.Visitor = (*statementMergeAlterTableChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementMergeAlterTable, &StatementMergeAlterTableAdvisor{})
-}
-
-// StatementMergeAlterTableAdvisor is the advisor checking for no redundant ALTER TABLE statements.
-type StatementMergeAlterTableAdvisor struct {
-}
-
-// Check checks for no redundant ALTER TABLE statements.
-func (*StatementMergeAlterTableAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &statementMergeAlterTableChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- tableMap: make(tableMap),
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.generateAdvice(), nil
-}
-
-func (checker *statementMergeAlterTableChecker) generateAdvice() []*storepb.Advice {
- var tableList []tableStatement
- for _, table := range checker.tableMap {
- tableList = append(tableList, table)
- }
- slices.SortFunc(tableList, func(i, j tableStatement) int {
- if i.line < j.line {
- return -1
- }
- if i.line > j.line {
- return 1
- }
- return 0
- })
- for _, table := range tableList {
- if table.count > 1 {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementRedundantAlterTable.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("There are %d statements to modify table `%s`", table.count, table.name),
- StartPosition: newPositionAtLineStart(table.line),
- })
- }
- }
-
- return checker.adviceList
-}
-
-type statementMergeAlterTableChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- tableMap tableMap
-}
-
-type tableMap map[string]tableStatement
-type tableStatement struct {
- schema string
- name string
- count int
- line int
-}
-
-func (m tableMap) set(schema string, table string, line int) {
- t := tableStatement{
- schema: schema,
- name: table,
- count: 1,
- line: line,
- }
- m[t.key()] = t
-}
-
-func (m tableMap) add(schema string, table string, line int) {
- if t, exists := m[fmt.Sprintf("%s.%s", schema, table)]; exists {
- t.count++
- t.line = line
- m[t.key()] = t
- }
-}
-
-func (t tableStatement) key() string {
- return fmt.Sprintf("%s.%s", t.schema, t.name)
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *statementMergeAlterTableChecker) Visit(in ast.Node) ast.Visitor {
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- checker.tableMap.set(node.Name.Schema, node.Name.Name, node.LastLine())
- case *ast.AlterTableStmt:
- checker.tableMap.add(node.Table.Schema, node.Table.Name, node.LastLine())
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_non_transactional.go b/backend/plugin/advisor/pg/advisor_statement_non_transactional.go
deleted file mode 100644
index 13eb8c74f1..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_non_transactional.go
+++ /dev/null
@@ -1,63 +0,0 @@
-package pg
-
-import (
- "context"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/db/pg"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NonTransactionalAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementNonTransactional, &NonTransactionalAdvisor{})
-}
-
-type NonTransactionalAdvisor struct {
-}
-
-func (*NonTransactionalAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &NonTransactionalChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- if pg.IsNonTransactionStatement(checker.text) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementNonTransactional.Int32(),
- Title: checker.title,
- Content: "This statement is non-transactional",
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- }
-
- return checker.adviceList, nil
-}
-
-type NonTransactionalChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
diff --git a/backend/plugin/advisor/pg/advisor_statement_object_owner_check.go b/backend/plugin/advisor/pg/advisor_statement_object_owner_check.go
deleted file mode 100644
index ee892e5355..0000000000
--- a/backend/plugin/advisor/pg/advisor_statement_object_owner_check.go
+++ /dev/null
@@ -1,607 +0,0 @@
-package pg
-
-import (
- "context"
- "database/sql"
- "fmt"
- "log/slog"
-
- "github.com/pkg/errors"
-
- "github.com/bytebase/bytebase/backend/common/log"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
- "github.com/bytebase/bytebase/backend/store/model"
-)
-
-var (
- _ advisor.Advisor = (*StatementObjectOwnerCheckAdvisor)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementObjectOwnerCheck, &StatementObjectOwnerCheckAdvisor{})
-}
-
-const (
- pgDatabaseOwner = "pg_database_owner"
-)
-
-type StatementObjectOwnerCheckAdvisor struct {
-}
-
-func (*StatementObjectOwnerCheckAdvisor) Check(ctx context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- var adviceList []*storepb.Advice
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- title := string(checkCtx.Rule.Type)
-
- dbMetadata := model.NewDatabaseMetadata(checkCtx.DBSchema, checkCtx.IsObjectCaseSensitive, true /* IsDetailCaseSensitive */)
- currentRole := checkCtx.DBSchema.Owner
- defaultSchema := "public"
- if !checkCtx.UsePostgresDatabaseOwner {
- currentRole, err = getCurrentUser(ctx, checkCtx.Driver)
- if err != nil {
- slog.Debug("Failed to get current user", log.BBError(err))
- currentRole = checkCtx.DBSchema.Owner
- }
- }
-
- for _, stmt := range stmtList {
- switch n := stmt.(type) {
- case *ast.VariableSetStmt:
- if n.Name == "role" {
- currentRole = n.GetRoleName()
- }
- case *ast.AlterSequenceStmt:
- // todo: use sequence owner instead of schema owner
- if n.Name == nil {
- continue
- }
- schemaName := n.Name.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Sequence \"%s\" is owned by \"%s\", but the current role is \"%s\".", n.Name.Name, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.AlterTableStmt:
- if n.Table == nil {
- continue
- }
- schemaName := n.Table.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- tableMeta := schemaMeta.GetTable(n.Table.Name)
- if tableMeta == nil {
- continue
- }
- owner := tableMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Table \"%s\" is owned by \"%s\", but the current role is \"%s\".", n.Table.Name, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.AlterTypeStmt:
- // todo: use type owner instead of schema owner
- if n.Type == nil {
- continue
- }
- schemaName := n.Type.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Type \"%s\" is owned by \"%s\", but the current role is \"%s\".", n.Type.Name, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateExtensionStmt:
- schemaName := n.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateFunctionStmt:
- if n.Function == nil {
- continue
- }
- schemaName := n.Function.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateIndexStmt:
- if n.Index == nil || n.Index.Table == nil {
- continue
- }
- schemaName := n.Index.Table.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateSchemaStmt:
- owner := dbMetadata.GetOwner()
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Database \"%s\" is owned by \"%s\", but the current role is \"%s\".", dbMetadata.GetName(), owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateSequenceStmt:
- if n.SequenceDef.SequenceName == nil {
- continue
- }
- schemaName := n.SequenceDef.SequenceName.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateTableStmt:
- if n.Name == nil {
- continue
- }
- schemaName := n.Name.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateTriggerStmt:
- if n.Trigger == nil || n.Trigger.Table == nil {
- continue
- }
- schemaName := n.Trigger.Table.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateTypeStmt:
- if n.Type == nil || n.Type.TypeName() == nil {
- continue
- }
- schemaName := n.Type.TypeName().Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.CreateViewStmt:
- if n.Name == nil {
- continue
- }
- schemaName := n.Name.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.DropFunctionStmt:
- for _, funcName := range n.FunctionList {
- if funcName == nil {
- continue
- }
- schemaName := funcName.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- case *ast.DropIndexStmt:
- for _, indexDef := range n.IndexList {
- if indexDef == nil {
- continue
- }
- schemaName := defaultSchema
- if indexDef.Table != nil && indexDef.Table.Schema != "" {
- schemaName = indexDef.Table.Schema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- case *ast.DropSchemaStmt:
- for _, schemaName := range n.SchemaList {
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- case *ast.DropSequenceStmt:
- for _, seqName := range n.SequenceNameList {
- if seqName == nil {
- continue
- }
- schemaName := seqName.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- case *ast.DropTableStmt:
- for _, table := range n.TableList {
- if table == nil {
- continue
- }
- schemaName := table.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- switch table.Type {
- case ast.TableTypeBaseTable:
- tableMeta := schemaMeta.GetTable(table.Name)
- if tableMeta == nil {
- continue
- }
- owner := tableMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Table \"%s\" is owned by \"%s\", but the current role is \"%s\".", table.Name, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- default:
- // todo: use view owner instead of schema owner
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- }
- case *ast.DropTriggerStmt:
- if n.Trigger == nil || n.Trigger.Table == nil {
- continue
- }
- schemaName := n.Trigger.Table.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.DropTypeStmt:
- for _, typeName := range n.TypeNameList {
- if typeName == nil {
- continue
- }
- schemaName := typeName.Schema
- if schemaName == "" {
- schemaName = defaultSchema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- case *ast.RenameIndexStmt:
- schemaName := defaultSchema
- if n.Table != nil && n.Table.Schema != "" {
- schemaName = n.Table.Schema
- }
- schemaMeta := dbMetadata.GetSchema(schemaName)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", schemaName, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- case *ast.RenameSchemaStmt:
- schemaMeta := dbMetadata.GetSchema(n.Schema)
- if schemaMeta == nil {
- continue
- }
- owner := schemaMeta.GetOwner()
- if owner == pgDatabaseOwner {
- owner = dbMetadata.GetOwner()
- }
- if owner != currentRole {
- adviceList = append(adviceList, &storepb.Advice{
- Status: level,
- Title: title,
- Content: fmt.Sprintf("Schema \"%s\" is owned by \"%s\", but the current role is \"%s\".", n.Schema, owner, currentRole),
- Code: advisor.StatementObjectOwnerCheck.Int32(),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
- }
-
- return adviceList, nil
-}
-
-func getCurrentUser(ctx context.Context, driver *sql.DB) (string, error) {
- var user string
- err := driver.QueryRowContext(ctx, "SELECT CURRENT_USER").Scan(&user)
- if err != nil {
- return "", err
- }
- return user, nil
-}
diff --git a/backend/plugin/advisor/pg/advisor_stmt_no_leading_wildcard_like.go b/backend/plugin/advisor/pg/advisor_stmt_no_leading_wildcard_like.go
deleted file mode 100644
index b0d98b9f2f..0000000000
--- a/backend/plugin/advisor/pg/advisor_stmt_no_leading_wildcard_like.go
+++ /dev/null
@@ -1,83 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-const (
- wildcard = "%"
-)
-
-var (
- _ advisor.Advisor = (*NoLeadingWildcardLikeAdvisor)(nil)
- _ ast.Visitor = (*noLeadingWildcardLikeChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementNoLeadingWildcardLike, &NoLeadingWildcardLikeAdvisor{})
-}
-
-// NoLeadingWildcardLikeAdvisor is the advisor checking for no leading wildcard LIKE.
-type NoLeadingWildcardLikeAdvisor struct {
-}
-
-// Check checks for no leading wildcard LIKE.
-func (*NoLeadingWildcardLikeAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &noLeadingWildcardLikeChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.leadingWildcardLike = false
- ast.Walk(checker, stmt)
-
- if checker.leadingWildcardLike {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementLeadingWildcardLike.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" uses leading wildcard LIKE", checker.text),
- StartPosition: newPositionAtLineStart(stmt.LastLine()),
- })
- }
- }
-
- return checker.adviceList, nil
-}
-
-type noLeadingWildcardLikeChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- leadingWildcardLike bool
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *noLeadingWildcardLikeChecker) Visit(node ast.Node) ast.Visitor {
- if n, ok := node.(*ast.PatternLikeDef); !checker.leadingWildcardLike && ok {
- if pattern, ok := n.Pattern.(*ast.StringDef); ok && len(pattern.Value) > 0 && pattern.Value[:1] == wildcard {
- checker.leadingWildcardLike = true
- }
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_stmt_no_select_all.go b/backend/plugin/advisor/pg/advisor_stmt_no_select_all.go
deleted file mode 100644
index f1a940b4ec..0000000000
--- a/backend/plugin/advisor/pg/advisor_stmt_no_select_all.go
+++ /dev/null
@@ -1,77 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*NoSelectAllAdvisor)(nil)
- _ ast.Visitor = (*noSelectAllChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementNoSelectAll, &NoSelectAllAdvisor{})
-}
-
-// NoSelectAllAdvisor is the advisor checking for no "select *".
-type NoSelectAllAdvisor struct {
-}
-
-// Check checks for no "select *".
-func (*NoSelectAllAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &noSelectAllChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type noSelectAllChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *noSelectAllChecker) Visit(node ast.Node) ast.Visitor {
- if n, ok := node.(*ast.SelectStmt); ok {
- for _, field := range n.FieldList {
- if column, ok := field.(*ast.ColumnNameDef); ok && column.ColumnName == "*" {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.StatementSelectAll.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" uses SELECT all", checker.text),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- break
- }
- }
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_stmt_where_required_select.go b/backend/plugin/advisor/pg/advisor_stmt_where_required_select.go
deleted file mode 100644
index 0fa0ed6433..0000000000
--- a/backend/plugin/advisor/pg/advisor_stmt_where_required_select.go
+++ /dev/null
@@ -1,80 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*WhereRequirementForSelectAdvisor)(nil)
- _ ast.Visitor = (*whereRequirementForSelectChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementRequireWhereForSelect, &WhereRequirementForSelectAdvisor{})
-}
-
-// WhereRequirementForSelectAdvisor is the advisor checking for the WHERE clause requirement for SELECT statements.
-type WhereRequirementForSelectAdvisor struct {
-}
-
-// Check checks for the WHERE clause requirement.
-func (*WhereRequirementForSelectAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &whereRequirementForSelectChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type whereRequirementForSelectChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *whereRequirementForSelectChecker) Visit(node ast.Node) ast.Visitor {
- code := advisor.Ok
- if n, ok := node.(*ast.SelectStmt); ok {
- // Allow SELECT queries without a FROM clause to proceed, e.g. SELECT 1.
- if n.WhereClause == nil && len(n.GetFromClause()) > 0 {
- code = advisor.StatementNoWhere
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" requires WHERE clause", checker.text),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_stmt_where_required_update_delete.go b/backend/plugin/advisor/pg/advisor_stmt_where_required_update_delete.go
deleted file mode 100644
index bef5bf3ede..0000000000
--- a/backend/plugin/advisor/pg/advisor_stmt_where_required_update_delete.go
+++ /dev/null
@@ -1,86 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*WhereRequirementForUpdateDeleteAdvisor)(nil)
- _ ast.Visitor = (*whereRequirementForUpdateDeleteChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleStatementRequireWhereForUpdateDelete, &WhereRequirementForUpdateDeleteAdvisor{})
-}
-
-// WhereRequirementForUpdateDeleteAdvisor is the advisor checking for the WHERE clause requirement.
-type WhereRequirementForUpdateDeleteAdvisor struct {
-}
-
-// Check checks for the WHERE clause requirement.
-func (*WhereRequirementForUpdateDeleteAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &whereRequirementForUpdateDeleteChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type whereRequirementForUpdateDeleteChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *whereRequirementForUpdateDeleteChecker) Visit(node ast.Node) ast.Visitor {
- code := advisor.Ok
- switch n := node.(type) {
- // DELETE
- case *ast.DeleteStmt:
- if n.WhereClause == nil {
- code = advisor.StatementNoWhere
- }
- // UPDATE
- case *ast.UpdateStmt:
- if n.WhereClause == nil {
- code = advisor.StatementNoWhere
- }
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("\"%s\" requires WHERE clause", checker.text),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_table_comment_convention.go b/backend/plugin/advisor/pg/advisor_table_comment_convention.go
deleted file mode 100644
index 6ab7c7ae58..0000000000
--- a/backend/plugin/advisor/pg/advisor_table_comment_convention.go
+++ /dev/null
@@ -1,134 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- "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/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*TableCommentConventionAdvisor)(nil)
- _ ast.Visitor = (*tableCommentConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableCommentConvention, &TableCommentConventionAdvisor{})
-}
-
-// TableCommentConventionAdvisor is the advisor checking for table comment convention.
-type TableCommentConventionAdvisor struct {
-}
-
-func (*TableCommentConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- payload, err := advisor.UnmarshalCommentConventionRulePayload(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &tableCommentConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- payload: payload,
- classificationConfig: checkCtx.ClassificationConfig,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- for _, createTableStmt := range checker.createdTableStmtList {
- var commentStmt *ast.CommentStmt
- for _, stmt := range checker.commentStmtList {
- tableDef, ok := stmt.Object.(*ast.TableDef)
- if !ok {
- continue
- }
- if tableDef.Name == createTableStmt.Name.Name && tableDef.Schema == createTableStmt.Name.Schema && tableDef.Database == createTableStmt.Name.Database {
- commentStmt = stmt
- // continue and find the last comment statement.
- }
- }
- if commentStmt == nil || commentStmt.Comment == "" {
- if checker.payload.Required {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentEmpty.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Comment is required for table `%s`", stringifyTableDef(createTableStmt.Name)),
- StartPosition: newPositionAtLineStart(createTableStmt.LastLine()),
- })
- }
- } else {
- comment := commentStmt.Comment
- if checker.payload.MaxLength > 0 && len(comment) > checker.payload.MaxLength {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentTooLong.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Table `%s` comment is too long. The length of comment should be within %d characters", stringifyTableDef(createTableStmt.Name), checker.payload.MaxLength),
- StartPosition: newPositionAtLineStart(commentStmt.LastLine()),
- })
- }
- if checker.payload.RequiredClassification {
- if classification, _ := common.GetClassificationAndUserComment(comment, checker.classificationConfig); classification == "" {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.CommentMissingClassification.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Table `%s` comment requires classification", stringifyTableDef(createTableStmt.Name)),
- StartPosition: newPositionAtLineStart(commentStmt.LastLine()),
- })
- }
- }
- }
- }
-
- return checker.adviceList, nil
-}
-
-type tableCommentConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- payload *advisor.CommentConventionRulePayload
- classificationConfig *storepb.DataClassificationSetting_DataClassificationConfig
-
- createdTableStmtList []*ast.CreateTableStmt
- commentStmtList []*ast.CommentStmt
-}
-
-func (checker *tableCommentConventionChecker) Visit(node ast.Node) ast.Visitor {
- if createTableStmt, ok := node.(*ast.CreateTableStmt); ok {
- checker.createdTableStmtList = append(checker.createdTableStmtList, createTableStmt)
- } else if commentStmt, ok := node.(*ast.CommentStmt); ok && commentStmt.Type == ast.ObjectTypeTable {
- checker.commentStmtList = append(checker.commentStmtList, commentStmt)
- }
- return checker
-}
-
-func stringifyTableDef(tableDef *ast.TableDef) string {
- if tableDef == nil {
- return ""
- }
- if tableDef.Database == "" && tableDef.Schema == "" {
- return tableDef.Name
- }
- if tableDef.Database == "" {
- return fmt.Sprintf("%s.%s", tableDef.Schema, tableDef.Name)
- }
- return fmt.Sprintf("%s.%s.%s", tableDef.Database, tableDef.Schema, tableDef.Name)
-}
diff --git a/backend/plugin/advisor/pg/advisor_table_disallow_partition.go b/backend/plugin/advisor/pg/advisor_table_disallow_partition.go
deleted file mode 100644
index 54fcfa60e0..0000000000
--- a/backend/plugin/advisor/pg/advisor_table_disallow_partition.go
+++ /dev/null
@@ -1,86 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*TableDisallowPartitionAdvisor)(nil)
- _ ast.Visitor = (*tableDisallowPartitionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableDisallowPartition, &TableDisallowPartitionAdvisor{})
-}
-
-// TableDisallowPartitionAdvisor is the advisor checking for disallow table partition.
-type TableDisallowPartitionAdvisor struct {
-}
-
-// Check checks for disallow table partition.
-func (*TableDisallowPartitionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
- checker := &tableDisallowPartitionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmtList {
- checker.text = stmt.Text()
- checker.line = stmt.LastLine()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type tableDisallowPartitionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
- line int
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *tableDisallowPartitionChecker) Visit(in ast.Node) ast.Visitor {
- code := advisor.Ok
-
- switch node := in.(type) {
- case *ast.CreateTableStmt:
- if node.PartitionDef != nil {
- code = advisor.CreateTablePartition
- }
- case *ast.AttachPartitionStmt:
- code = advisor.CreateTablePartition
- }
-
- if code != advisor.Ok {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: code.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Table partition is forbidden, but \"%s\" creates", checker.text),
- StartPosition: newPositionAtLineStart(checker.line),
- })
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go b/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go
deleted file mode 100644
index 3a57b6b8bd..0000000000
--- a/backend/plugin/advisor/pg/advisor_table_drop_naming_convention.go
+++ /dev/null
@@ -1,83 +0,0 @@
-package pg
-
-// Framework code is generated by the generator.
-
-import (
- "context"
- "fmt"
- "regexp"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*TableDropNamingConventionAdvisor)(nil)
- _ ast.Visitor = (*tableDropNamingConventionChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableDropNamingConvention, &TableDropNamingConventionAdvisor{})
-}
-
-// TableDropNamingConventionAdvisor is the advisor checking for table drop with naming convention.
-type TableDropNamingConventionAdvisor struct {
-}
-
-// Check checks for table drop with naming convention.
-func (*TableDropNamingConventionAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmtList, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- format, _, err := advisor.UnmarshalNamingRulePayloadAsRegexp(checkCtx.Rule.Payload)
- if err != nil {
- return nil, err
- }
- checker := &tableDropNamingConventionChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- format: format,
- }
-
- for _, stmt := range stmtList {
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type tableDropNamingConventionChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- format *regexp.Regexp
-}
-
-// Visit implements ast.Visitor interface.
-func (checker *tableDropNamingConventionChecker) Visit(in ast.Node) ast.Visitor {
- if node, ok := in.(*ast.DropTableStmt); ok {
- for _, table := range node.TableList {
- if !checker.format.MatchString(table.Name) {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.TableDropNamingConventionMismatch.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("`%s` mismatches drop table naming convention, naming format should be %q", table.Name, checker.format),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
- }
- }
-
- return checker
-}
diff --git a/backend/plugin/advisor/pg/advisor_table_no_fk.go b/backend/plugin/advisor/pg/advisor_table_no_fk.go
deleted file mode 100644
index a3e027fa53..0000000000
--- a/backend/plugin/advisor/pg/advisor_table_no_fk.go
+++ /dev/null
@@ -1,105 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*TableNoFKAdvisor)(nil)
- _ ast.Visitor = (*tableNoFKChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableNoFK, &TableNoFKAdvisor{})
-}
-
-// TableNoFKAdvisor is the advisor checking table disallow foreign key.
-type TableNoFKAdvisor struct {
-}
-
-// Check checks table disallow foreign key.
-func (*TableNoFKAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &tableNoFKChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- }
-
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type tableNoFKChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- text string
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *tableNoFKChecker) Visit(node ast.Node) ast.Visitor {
- var tableHasFK *ast.TableDef
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- for _, column := range n.ColumnList {
- if containFK(column.ConstraintList) {
- tableHasFK = n.Name
- break
- }
- }
- if containFK(n.ConstraintList) {
- tableHasFK = n.Name
- }
- // ADD CONSTRAINT
- case *ast.AddConstraintStmt:
- if n.Constraint.Type == ast.ConstraintTypeForeign {
- tableHasFK = n.Table
- }
- }
-
- if tableHasFK != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.TableHasFK.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Foreign key is not allowed in the table %q.%q, related statement: \"%s\"",
- normalizeSchemaName(tableHasFK.Schema),
- tableHasFK.Name,
- checker.text,
- ),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
-
- return checker
-}
-
-func containFK(list []*ast.ConstraintDef) bool {
- for _, cons := range list {
- if cons.Type == ast.ConstraintTypeForeign {
- return true
- }
- }
- return false
-}
diff --git a/backend/plugin/advisor/pg/advisor_table_require_pk.go b/backend/plugin/advisor/pg/advisor_table_require_pk.go
deleted file mode 100644
index b9e20e87bc..0000000000
--- a/backend/plugin/advisor/pg/advisor_table_require_pk.go
+++ /dev/null
@@ -1,129 +0,0 @@
-package pg
-
-import (
- "context"
- "fmt"
-
- "github.com/pkg/errors"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
- "github.com/bytebase/bytebase/backend/plugin/advisor/catalog"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-var (
- _ advisor.Advisor = (*TableRequirePKAdvisor)(nil)
- _ ast.Visitor = (*tableRequirePKChecker)(nil)
-)
-
-func init() {
- advisor.Register(storepb.Engine_POSTGRES, advisor.SchemaRuleTableRequirePK, &TableRequirePKAdvisor{})
-}
-
-// TableRequirePKAdvisor is the advisor checking table requires PK.
-type TableRequirePKAdvisor struct {
-}
-
-// Check parses the given statement and checks for errors.
-func (*TableRequirePKAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
- stmts, ok := checkCtx.AST.([]ast.Node)
- if !ok {
- return nil, errors.Errorf("failed to convert to Node")
- }
-
- level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
- if err != nil {
- return nil, err
- }
-
- checker := &tableRequirePKChecker{
- level: level,
- title: string(checkCtx.Rule.Type),
- catalog: checkCtx.Catalog,
- }
-
- for _, stmt := range stmts {
- checker.text = stmt.Text()
- ast.Walk(checker, stmt)
- }
-
- return checker.adviceList, nil
-}
-
-type tableRequirePKChecker struct {
- adviceList []*storepb.Advice
- level storepb.Advice_Status
- title string
- catalog *catalog.Finder
- text string
-}
-
-// Visit implements the ast.Visitor interface.
-func (checker *tableRequirePKChecker) Visit(node ast.Node) ast.Visitor {
- var missingPK *ast.TableDef
- switch n := node.(type) {
- // CREATE TABLE
- case *ast.CreateTableStmt:
- hasPK := false
- for _, column := range n.ColumnList {
- if containPK(column.ConstraintList) {
- hasPK = true
- }
- }
- if containPK(n.ConstraintList) {
- hasPK = true
- }
- if !hasPK {
- missingPK = n.Name
- }
- // DROP CONSTRAINT
- case *ast.DropConstraintStmt:
- _, index := checker.catalog.Origin.FindIndex(&catalog.IndexFind{
- SchemaName: normalizeSchemaName(n.Table.Schema),
- TableName: n.Table.Name,
- IndexName: n.ConstraintName,
- })
- if index != nil && index.Primary() {
- missingPK = n.Table
- }
- // DROP COLUMN
- case *ast.DropColumnStmt:
- pk := checker.catalog.Origin.FindPrimaryKey(&catalog.PrimaryKeyFind{
- SchemaName: normalizeSchemaName(n.Table.Schema),
- TableName: n.Table.Name,
- })
- if pk != nil {
- for _, column := range pk.ExpressionList() {
- if column == n.ColumnName {
- missingPK = n.Table
- }
- }
- }
- }
-
- if missingPK != nil {
- checker.adviceList = append(checker.adviceList, &storepb.Advice{
- Status: checker.level,
- Code: advisor.TableNoPK.Int32(),
- Title: checker.title,
- Content: fmt.Sprintf("Table %q.%q requires PRIMARY KEY, related statement: %q",
- normalizeSchemaName(missingPK.Schema),
- missingPK.Name,
- checker.text,
- ),
- StartPosition: newPositionAtLineStart(node.LastLine()),
- })
- }
-
- return checker
-}
-
-func containPK(list []*ast.ConstraintDef) bool {
- for _, cons := range list {
- if cons.Type == ast.ConstraintTypePrimary || cons.Type == ast.ConstraintTypePrimaryUsingIndex {
- return true
- }
- }
- return false
-}
diff --git a/backend/plugin/advisor/pg/pg_rules_test.go b/backend/plugin/advisor/pg/pg_rules_test.go
deleted file mode 100644
index 0580a8337c..0000000000
--- a/backend/plugin/advisor/pg/pg_rules_test.go
+++ /dev/null
@@ -1,77 +0,0 @@
-package pg
-
-import (
- "testing"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/advisor"
-)
-
-func TestPostgreSQLRules(t *testing.T) {
- pgRules := []advisor.SQLReviewRuleType{
- advisor.BuiltinRulePriorBackupCheck,
- advisor.SchemaRuleColumnNotNull,
- advisor.SchemaRuleRequiredColumn,
- advisor.SchemaRuleColumnTypeDisallowList,
- advisor.SchemaRuleCommentLength,
- advisor.SchemaRuleIndexKeyNumberLimit,
- advisor.SchemaRuleIndexNoDuplicateColumn,
- advisor.SchemaRuleFullyQualifiedObjectName,
- advisor.SchemaRuleColumnNaming,
- advisor.SchemaRuleFKNaming,
- advisor.SchemaRuleIDXNaming,
- advisor.SchemaRulePKNaming,
- advisor.SchemaRuleUKNaming,
- advisor.SchemaRuleTableNaming,
- advisor.SchemaRuleSchemaBackwardCompatibility,
- advisor.SchemaRuleStatementInsertRowLimit,
- advisor.SchemaRuleStatementNoSelectAll,
- advisor.SchemaRuleStatementNoLeadingWildcardLike,
- advisor.SchemaRuleStatementNonTransactional,
- advisor.SchemaRuleStatementRequireWhereForSelect,
- advisor.SchemaRuleStatementRequireWhereForUpdateDelete,
- advisor.SchemaRuleCharsetAllowlist,
- advisor.SchemaRuleTableNoFK,
- advisor.SchemaRuleTableRequirePK,
- advisor.SchemaRuleColumnDisallowChangeType,
- advisor.SchemaRuleTableDisallowPartition,
- advisor.SchemaRuleIndexPrimaryKeyTypeAllowlist,
- advisor.SchemaRuleColumnMaximumCharacterLength,
- advisor.SchemaRuleStatementDisallowRemoveTblCascade,
- advisor.SchemaRuleStatementDisallowOnDelCascade,
- advisor.SchemaRuleStatementDisallowCommit,
- advisor.SchemaRuleStatementDMLDryRun,
- advisor.SchemaRuleStatementInsertMustSpecifyColumn,
- advisor.SchemaRuleStatementInsertDisallowOrderByRand,
- advisor.SchemaRuleTableDropNamingConvention,
- advisor.SchemaRuleCollationAllowlist,
- advisor.SchemaRuleIndexTotalNumberLimit,
- advisor.SchemaRuleStatementAffectedRowLimit,
- advisor.SchemaRuleStatementMergeAlterTable,
- advisor.SchemaRuleColumnRequireDefault,
- advisor.SchemaRuleColumnDefaultDisallowVolatile,
- advisor.SchemaRuleStatementDisallowAddColumnWithDefault,
- advisor.SchemaRuleCreateIndexConcurrently,
- advisor.SchemaRuleStatementAddCheckNotValid,
- advisor.SchemaRuleStatementAddFKNotValid,
- advisor.SchemaRuleStatementDisallowAddNotNull,
- advisor.SchemaRuleStatementCreateSpecifySchema,
- advisor.SchemaRuleStatementCheckSetRoleVariable,
- advisor.SchemaRuleStatementMaximumLimitValue,
- advisor.SchemaRuleTableCommentConvention,
- advisor.SchemaRuleColumnCommentConvention,
- advisor.SchemaRuleStatementDisallowMixInDDL,
- advisor.SchemaRuleStatementDisallowMixInDML,
- }
-
- for _, rule := range pgRules {
- _, needMetaData := advisorNeedMockData[rule]
- advisor.RunSQLReviewRuleTest(t, rule, storepb.Engine_POSTGRES, needMetaData, false /* record */)
- }
-}
-
-// Add SQL review type here if you need metadata for test.
-var advisorNeedMockData = map[advisor.SQLReviewRuleType]bool{
- advisor.SchemaRuleFullyQualifiedObjectName: true,
- advisor.BuiltinRulePriorBackupCheck: true,
-}
diff --git a/backend/plugin/advisor/pg/test/builtin_prior_backup_check.yaml b/backend/plugin/advisor/pg/test/builtin_prior_backup_check.yaml
deleted file mode 100644
index 0ece15a37d..0000000000
--- a/backend/plugin/advisor/pg/test/builtin_prior_backup_check.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-- statement: |-
- UPDATE tech_book SET id = 1 WHERE id = 1 and name = 'test';
- UPDATE tech_book SET id = 2 WHERE id = 2 and name = 'test';
- UPDATE tech_book SET id = 3 WHERE id = 3 and name = 'test';
- UPDATE tech_book SET id = 4 WHERE id = 4 and name = 'test';
- UPDATE tech_book SET id = 4 WHERE id = 4 and name = 'test';
- UPDATE abc SET id = 4 WHERE id = 4 and name = 'test';
- changeType: 2
-- statement: |-
- UPDATE tech_book SET id = 1 WHERE id = 1 and name = 'test';
- UPDATE tech_book SET id = 2 WHERE id = 2 and name = 'test';
- UPDATE tech_book SET id = 3 WHERE id = 3 and name = 'test';
- UPDATE tech_book SET id = 4 WHERE id = 4 and name = 'test';
- UPDATE tech_book SET id = 5 WHERE id = 5 and name = 'test';
- UPDATE tech_book SET id = 6 WHERE id = 6 and name = 'test';
- UPDATE tech_book SET id = 7 WHERE id = 7 and name = 'test';
- changeType: 2
-- statement: |-
- UPDATE tech_book SET id = 1 WHERE id = 1;
- UPDATE tech_book SET id = 2 WHERE id = 2;
- UPDATE tech_book SET id = 3 WHERE id = 3;
- UPDATE tech_book SET id = 4 WHERE id = 4;
- UPDATE tech_book SET id = 5 WHERE id = 5;
- UPDATE tech_book SET id = 6 WHERE id = 6;
- UPDATE tech_book SET id = 7 WHERE id = 7;
- changeType: 2
-- statement: DELETE FROM tech_book WHERE a > 1;
- changeType: 2
-- statement: UPDATE tech_book SET id = 1;
- changeType: 2
-- statement: CREATE TABLE t_test_backup(a int);DELETE FROM tech_book WHERE a > 1;
- changeType: 2
- want:
- - status: 2
- code: 2001
- title: builtin.prior-backup-check
- content: Data change can only run DML, "CREATE TABLE t_test_backup(a int);" is not DML
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SET ROLE role1;DELETE FROM tech_book WHERE a > 1;
- changeType: 2
diff --git a/backend/plugin/advisor/pg/test/column_comment.yaml b/backend/plugin/advisor/pg/test/column_comment.yaml
deleted file mode 100644
index d62bd0e41a..0000000000
--- a/backend/plugin/advisor/pg/test/column_comment.yaml
+++ /dev/null
@@ -1,55 +0,0 @@
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON COLUMN t.a IS 'comments';
- changeType: 1
-- statement: CREATE TABLE t(a int);
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: column.comment
- content: Comment is required for column `t.a`
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON COLUMN t.a IS 'loooooooong comments';
- changeType: 1
- want:
- - status: 2
- code: 1301
- title: column.comment
- content: Column `t.a` comment is too long. The length of comment should be within 10 characters
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int, d text);
- COMMENT ON COLUMN t.a IS 'comments';
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: column.comment
- content: Comment is required for column `t.d`
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON COLUMN t.a IS 'loooooooong comments';
- COMMENT ON COLUMN t.a IS NULL;
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: column.comment
- content: Comment is required for column `t.a`
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/column_default_disallow_volatile.yaml b/backend/plugin/advisor/pg/test/column_default_disallow_volatile.yaml
deleted file mode 100644
index 85d842a879..0000000000
--- a/backend/plugin/advisor/pg/test/column_default_disallow_volatile.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: CREATE TABLE t(a serial primary key, b int default 1, c boolean default true, d int default current_user)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD COLUMN b timestamp default now();
- changeType: 1
- want:
- - status: 2
- code: 420
- title: column.default-disallow-volatile
- content: Column "tech_book"."b" in schema "public" has volatile DEFAULT
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/column_disallow_change_type.yaml b/backend/plugin/advisor/pg/test/column_disallow_change_type.yaml
deleted file mode 100644
index 4541a807e6..0000000000
--- a/backend/plugin/advisor/pg/test/column_disallow_change_type.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: ALTER TABLE tech_book ALTER COLUMN id SET DATA TYPE INTEGER
- changeType: 1
- want:
- - status: 2
- code: 403
- title: column.disallow-change-type
- content: The statement "ALTER TABLE tech_book ALTER COLUMN id SET DATA TYPE INTEGER" changes column type
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD COLUMN c1 int
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/column_maximum_character_length.yaml b/backend/plugin/advisor/pg/test/column_maximum_character_length.yaml
deleted file mode 100644
index d6eeec361b..0000000000
--- a/backend/plugin/advisor/pg/test/column_maximum_character_length.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-- statement: CREATE TABLE t(name char(20));
- changeType: 1
-- statement: CREATE TABLE t(name varchar(225));
- changeType: 1
-- statement: CREATE TABLE t(name char(225));
- changeType: 1
- want:
- - status: 2
- code: 415
- title: column.maximum-character-length
- content: The length of the CHAR column "name" in table "t" is bigger than 20, please use VARCHAR instead
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE public.tech_book ADD COLUMN name_2 char(225)
- changeType: 1
- want:
- - status: 2
- code: 415
- title: column.maximum-character-length
- content: The length of the CHAR column "name_2" in table "public"."tech_book" is bigger than 20, please use VARCHAR instead
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ALTER COLUMN name SET DATA TYPE char(225)
- changeType: 1
- want:
- - status: 2
- code: 415
- title: column.maximum-character-length
- content: The length of the CHAR column "name" in table "tech_book" is bigger than 20, please use VARCHAR instead
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/column_no_null.yaml b/backend/plugin/advisor/pg/test/column_no_null.yaml
deleted file mode 100644
index 895f757eb0..0000000000
--- a/backend/plugin/advisor/pg/test/column_no_null.yaml
+++ /dev/null
@@ -1,89 +0,0 @@
-- statement: |-
- CREATE TABLE book (
- id int,
- name varchar(255)
- )
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "id" in "public"."book" cannot have NULL value
- startposition:
- line: 2
- column: 0
- endposition: null
- - status: 2
- code: 402
- title: column.no-null
- content: Column "name" in "public"."book" cannot have NULL value
- startposition:
- line: 3
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id int, name varchar(255), PRIMARY KEY (id))
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "name" in "public"."book" cannot have NULL value
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id int PRIMARY KEY, name varchar(255))
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "name" in "public"."book" cannot have NULL value
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id int NOT NULL, name varchar(255))
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "name" in "public"."book" cannot have NULL value
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id int PRIMARY KEY, name varchar(255) NOT NULL)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD COLUMN reader int
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "reader" in "public"."tech_book" cannot have NULL value
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- ALTER TABLE tech_book DROP COLUMN id;
- ALTER TABLE tech_book DROP COLUMN name;
- ALTER TABLE tech_book ADD COLUMN id int PRIMARY KEY, ADD COLUMN name varchar(255) NOT NULL;
- changeType: 1
-- statement: ALTER TABLE tech_book ALTER COLUMN id SET NOT NULL
- changeType: 1
-- statement: ALTER TABLE tech_book ALTER COLUMN name DROP NOT NULL
- changeType: 1
- want:
- - status: 2
- code: 402
- title: column.no-null
- content: Column "name" in "public"."tech_book" cannot have NULL value
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: /* this is a comment */
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/column_require_default.yaml b/backend/plugin/advisor/pg/test/column_require_default.yaml
deleted file mode 100644
index 65691f6aba..0000000000
--- a/backend/plugin/advisor/pg/test/column_require_default.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-- statement: |-
- CREATE TABLE t(
- a int not null,
- b text,
- primary key (a)
- );
- changeType: 1
- want:
- - status: 2
- code: 420
- title: column.require-default
- content: Column "t"."a" in schema "public" doesn't have DEFAULT
- startposition:
- line: 2
- column: 0
- endposition: null
- - status: 2
- code: 420
- title: column.require-default
- content: Column "t"."b" in schema "public" doesn't have DEFAULT
- startposition:
- line: 3
- column: 0
- endposition: null
-- statement: CREATE TABLE t(a serial primary key, b int default 1)
- changeType: 1
-- statement: |-
- CREATE TABLE t(
- a int,
- b int default 1
- )
- changeType: 1
- want:
- - status: 2
- code: 420
- title: column.require-default
- content: Column "t"."a" in schema "public" doesn't have DEFAULT
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- ALTER TABLE tech_book ADD COLUMN a BLOB;
- ALTER TABLE tech_book ADD COLUMN b timestamp;
- changeType: 1
- want:
- - status: 2
- code: 420
- title: column.require-default
- content: Column "tech_book"."a" in schema "public" doesn't have DEFAULT
- startposition:
- line: 1
- column: 0
- endposition: null
- - status: 2
- code: 420
- title: column.require-default
- content: Column "tech_book"."b" in schema "public" doesn't have DEFAULT
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/column_required.yaml b/backend/plugin/advisor/pg/test/column_required.yaml
deleted file mode 100644
index e0ed57553b..0000000000
--- a/backend/plugin/advisor/pg/test/column_required.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-- statement: CREATE TABLE book(id int)
- changeType: 1
- want:
- - status: 2
- code: 401
- title: column.required
- content: 'Table "book" requires columns: created_ts, creator_id, updated_ts, updater_id'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE book(
- id int,
- creator_id int,
- created_ts timestamp,
- updater_id int,
- updated_ts timestamp)
- changeType: 1
-- statement: |-
- ALTER TABLE tech_book ADD COLUMN creator_id int;
- ALTER TABLE tech_book RENAME COLUMN creator_id TO creator;
- changeType: 1
- want:
- - status: 2
- code: 401
- title: column.required
- content: 'Table "tech_book" requires columns: creator_id'
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- ALTER TABLE tech_book ADD COLUMN creator_id int;
- ALTER TABLE tech_book DROP COLUMN creator_id;
- changeType: 1
- want:
- - status: 2
- code: 401
- title: column.required
- content: 'Table "tech_book" requires columns: creator_id'
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/column_type_disallow_list.yaml b/backend/plugin/advisor/pg/test/column_type_disallow_list.yaml
deleted file mode 100644
index c24eefb0e3..0000000000
--- a/backend/plugin/advisor/pg/test/column_type_disallow_list.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-- statement: CREATE TABLE t(a char(5));
- changeType: 1
-- statement: CREATE TABLE t(a int, b JSON);
- changeType: 1
- want:
- - status: 2
- code: 411
- title: column.type-disallow-list
- content: Disallow column type JSON but column "t"."b" is
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(d char(5));
- ALTER TABLE t add COLUMN a JSON;
- changeType: 1
- want:
- - status: 2
- code: 411
- title: column.type-disallow-list
- content: Disallow column type JSON but column "t"."a" is
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/index_create_concurrently.yaml b/backend/plugin/advisor/pg/test/index_create_concurrently.yaml
deleted file mode 100644
index 564d6485c9..0000000000
--- a/backend/plugin/advisor/pg/test/index_create_concurrently.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-- statement: create index on tech_book(id);
- changeType: 1
- want:
- - status: 2
- code: 814
- title: index.create-concurrently
- content: Creating indexes will block writes on the table, unless use CONCURRENTLY
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: create index concurrently on tech_book(id);
- changeType: 1
-- statement: |
- CREATE TABLE feed_subscription (
- id uuid NOT NULL DEFAULT gen_random_uuid(),
- userId uuid NOT NULL,
- projectId uuid,
- CONSTRAINT PK_feed_subscription PRIMARY KEY (id)
- );
- CREATE INDEX IDX_feed_subscription_userId ON feed_subscription (userId);
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/index_key_number_limit.yaml b/backend/plugin/advisor/pg/test/index_key_number_limit.yaml
deleted file mode 100644
index 7f413d596f..0000000000
--- a/backend/plugin/advisor/pg/test/index_key_number_limit.yaml
+++ /dev/null
@@ -1,67 +0,0 @@
-- statement: CREATE TABLE t(name char(20));
- changeType: 1
-- statement: CREATE TABLE t(name varchar(225));
- changeType: 1
-- statement: CREATE TABLE t(name char(225), PRIMARY KEY (name));
- changeType: 1
-- statement: CREATE TABLE t(id int, name char(225), c1 int, c2 int, c3 int, c4 int, CONSTRAINT t_id_name PRIMARY KEY (id, name, c1, c2, c3, c4));
- changeType: 1
- want:
- - status: 2
- code: 802
- title: index.key-number-limit
- content: The number of keys of index "t_id_name" in table "t" should be not greater than 5
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE t(id int, name char(225), c1 int, c2 int, c3 int, c4 int, CONSTRAINT t_id_name UNIQUE (id, name, c1, c2, c3, c4));
- changeType: 1
- want:
- - status: 2
- code: 802
- title: index.key-number-limit
- content: The number of keys of index "t_id_name" in table "t" should be not greater than 5
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE address(id int, phone varchar(225), c1 int, c2 int, c3 int, c4 int);
- CREATE INDEX idx_address_phone ON address(id, phone, c1, c2, c3, c4);
- changeType: 1
- want:
- - status: 2
- code: 802
- title: index.key-number-limit
- content: The number of keys of index "idx_address_phone" in table "address" should be not greater than 5
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE address(id int, phone varchar(225), c1 int, c2 int, c3 int, c4 int);
- CREATE UNIQUE INDEX idx_address_phone ON address(id, phone, c2, c1, c3, c4);
- changeType: 1
- want:
- - status: 2
- code: 802
- title: index.key-number-limit
- content: The number of keys of index "idx_address_phone" in table "address" should be not greater than 5
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE address(id int, phone varchar(225), c1 int, c2 int, c3 int, c4 int);
- ALTER TABLE address ADD CONSTRAINT address_id_name UNIQUE (id, phone, c1, c2, c3, c4);
- changeType: 1
- want:
- - status: 2
- code: 802
- title: index.key-number-limit
- content: The number of keys of index "address_id_name" in table "address" should be not greater than 5
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/index_no_duplicate_column.yaml b/backend/plugin/advisor/pg/test/index_no_duplicate_column.yaml
deleted file mode 100644
index f64dbd808b..0000000000
--- a/backend/plugin/advisor/pg/test/index_no_duplicate_column.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-- statement: CREATE TABLE t (a INT, PRIMARY KEY (a));
- changeType: 1
-- statement: |-
- CREATE TABLE t (
- a int,
- PRIMARY KEY (a, a));
- changeType: 1
- want:
- - status: 2
- code: 812
- title: index.no-duplicate-column
- content: PRIMARY KEY "" has duplicate column "t"."a"
- startposition:
- line: 3
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- CREATE INDEX idx_a on t(a, a);
- changeType: 1
- want:
- - status: 2
- code: 812
- title: index.no-duplicate-column
- content: INDEX "idx_a" has duplicate column "t"."a"
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- ALTER TABLE t ADD CONSTRAINT uk_a UNIQUE (a, a);
- changeType: 1
- want:
- - status: 2
- code: 812
- title: index.no-duplicate-column
- content: UNIQUE KEY "uk_a" has duplicate column "t"."a"
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- ALTER TABLE t ADD CONSTRAINT pk_a PRIMARY KEY (a, a);
- changeType: 1
- want:
- - status: 2
- code: 812
- title: index.no-duplicate-column
- content: PRIMARY KEY "pk_a" has duplicate column "t"."a"
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- ALTER TABLE t ADD CONSTRAINT fk_a FOREIGN KEY (a, a) REFERENCES t1(a, b);
- changeType: 1
- want:
- - status: 2
- code: 812
- title: index.no-duplicate-column
- content: FOREIGN KEY "fk_a" has duplicate column "t"."a"
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/index_primary_key_type_allowlist.yaml b/backend/plugin/advisor/pg/test/index_primary_key_type_allowlist.yaml
deleted file mode 100644
index 081fdbe689..0000000000
--- a/backend/plugin/advisor/pg/test/index_primary_key_type_allowlist.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-- statement: CREATE TABLE t(a SERIAL PRIMARY KEY);
- changeType: 1
-- statement: CREATE TABLE t(a BIGSERIAL, PRIMARY KEY(a));
- changeType: 1
-- statement: |-
- CREATE TABLE t(
- a varchar(20) PRIMARY KEY
- );
- changeType: 1
- want:
- - status: 2
- code: 803
- title: index.primary-key-type-allowlist
- content: The column "a" is one of the primary key, but its type "character varying(20)" is not in allowlist
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(
- a varchar(20),
- PRIMARY KEY(a)
- );
- changeType: 1
- want:
- - status: 2
- code: 803
- title: index.primary-key-type-allowlist
- content: The column "a" is one of the primary key, but its type "character varying(20)" is not in allowlist
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/index_total_number_limit.yaml b/backend/plugin/advisor/pg/test/index_total_number_limit.yaml
deleted file mode 100644
index 0da89ace7c..0000000000
--- a/backend/plugin/advisor/pg/test/index_total_number_limit.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-- statement: CREATE TABLE t(a int, b int, c int, unique (a, b, c))
- changeType: 1
-- statement: CREATE INDEX idx_id_name on tech_book(id, name)
- changeType: 1
-- statement: |-
- CREATE INDEX idx_id_name_1 on tech_book(id, name);
- CREATE INDEX idx_id_name_2 on tech_book(id, name);
- CREATE INDEX idx_id_name_3 on tech_book(id, name);
- CREATE INDEX idx_id_name_4 on tech_book(id, name);
- CREATE INDEX idx_id_name_5 on tech_book(id, name);
- changeType: 1
- want:
- - status: 2
- code: 813
- title: index.total-number-limit
- content: The count of index in table "public"."tech_book" should be no more than 5, but found 8
- startposition:
- line: 5
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int PRIMARY KEY, b int, c int);
- CREATE INDEX idx_a_b_1 on t(a, b);
- CREATE INDEX idx_a_b_2 on t(a, b);
- CREATE INDEX idx_a_b_3 on t(a, b);
- CREATE INDEX idx_a_b_4 on t(a, b);
- CREATE INDEX idx_a_b_5 on t(a, b);
- changeType: 1
- want:
- - status: 2
- code: 813
- title: index.total-number-limit
- content: The count of index in table "public"."t" should be no more than 5, but found 6
- startposition:
- line: 6
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(
- a int PRIMARY KEY,
- b int,
- c int,
- CONSTRAINT idx_a_b_1 UNIQUE (a, b),
- CONSTRAINT idx_a_b_2 UNIQUE (a, b),
- CONSTRAINT idx_a_b_3 UNIQUE (a, b),
- CONSTRAINT idx_a_b_4 UNIQUE (a, b),
- CONSTRAINT idx_a_b_5 UNIQUE (a, b));
- changeType: 1
- want:
- - status: 2
- code: 813
- title: index.total-number-limit
- content: The count of index in table "public"."t" should be no more than 5, but found 6
- startposition:
- line: 9
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/naming_column.yaml b/backend/plugin/advisor/pg/test/naming_column.yaml
deleted file mode 100644
index 476da7f842..0000000000
--- a/backend/plugin/advisor/pg/test/naming_column.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-- statement: CREATE TABLE book(id int, "creatorId" int)
- changeType: 1
- want:
- - status: 2
- code: 302
- title: naming.column
- content: '"book"."creatorId" mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id int, qavszgslczmsacubtvyymzhojfytkcmon int)
- changeType: 1
-- statement: CREATE TABLE book(id int, creator_Id int)
- changeType: 1
-- statement: CREATE TABLE book(id int, creator_id int)
- changeType: 1
-- statement: |-
- CREATE TABLE book(id int, creator_id int);
- ALTER TABLE book ADD COLUMN "creatorId" int
- changeType: 1
- want:
- - status: 2
- code: 302
- title: naming.column
- content: '"book"."creatorId" mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE book(id int, creator_id int);
- ALTER TABLE book ADD COLUMN "creator" int
- changeType: 1
-- statement: |-
- CREATE TABLE book(id int, creator_id int);
- ALTER TABLE book RENAME COLUMN creator_id TO "creatorId"
- changeType: 1
- want:
- - status: 2
- code: 302
- title: naming.column
- content: '"book"."creatorId" mismatches column naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE book(id int, creator_id int);
- ALTER TABLE book RENAME COLUMN creator_id TO "creator"
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/naming_fully_qualified.yaml b/backend/plugin/advisor/pg/test/naming_fully_qualified.yaml
deleted file mode 100644
index f09ac6c1b3..0000000000
--- a/backend/plugin/advisor/pg/test/naming_fully_qualified.yaml
+++ /dev/null
@@ -1,103 +0,0 @@
-- statement: |-
- CREATE TABLE public.pokesv1 (foo int, bar varchar);
- INSERT INTO public.pokesv1 VALUES (1, '1');
- CREATE TABLE public.pokes (foo int);
- CREATE TABLE pokesv2 (foo int, bar varchar);
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''pokesv2'''
- startposition:
- line: 4
- column: 0
- endposition: null
-- statement: |-
- CREATE SEQUENCE public.seq;
- CREATE SEQUENCE seq;
- DROP SEQUENCE public.seq
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''seq'''
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TRIGGER test_trigger
- AFTER INSERT ON pokesv1
- FOR EACH ROW
- EXECUTE PROCEDURE trigger_function();
- INSERT INTO bbdev.public.pokesv1 VALUES (1, '1');
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''pokesv1'''
- startposition:
- line: 4
- column: 0
- endposition: null
-- statement: DROP TRIGGER test_trigger ON public.pokes;
- changeType: 1
-- statement: |-
- CREATE TABLE public.pokesv1 (foo int, bar varchar);
- ALTER TABLE pokesv1 RENAME TO pokesv2;
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''pokesv1'''
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE public.pokesv1 (foo int);
- INSERT INTO pokesv1(foo) VALUES (1);
- INSERT INTO public.pokesv1 VALUES (2);
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''pokesv1'''
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE public.pokesv1 (foo int);
- UPDATE public.pokesv1 SET foo = 1 WHERE 1=1;
- UPDATE public.pokesv1 SET foo = 2 WHERE foo=1;
- UPDATE pokesv1 SET foo = 1 WHERE 1=1;
- UPDATE public.pokesv1 SET foo = 1 WHERE 1 > 1;
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''pokesv1'''
- startposition:
- line: 4
- column: 0
- endposition: null
-- statement: "CREATE TABLE public.pokes (foo int); \nSELECT * FROM (SELECT (id) FROM tech_book) AS foo;"
- changeType: 1
- want:
- - status: 2
- code: 310
- title: naming.fully-qualified
- content: 'unqualified object name: ''tech_book'''
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: "CREATE TABLE public.pokes (foo int);\nWITH foo1 AS (SELECT * FROM public.tech_book) \nSELECT * FROM foo1;"
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/naming_index_fk.yaml b/backend/plugin/advisor/pg/test/naming_index_fk.yaml
deleted file mode 100644
index 8ccacc5cb9..0000000000
--- a/backend/plugin/advisor/pg/test/naming_index_fk.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_tech_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_author_id FOREIGN KEY (author_id) REFERENCES author (id)
- changeType: 1
- want:
- - status: 2
- code: 305
- title: naming.index.fk
- content: Foreign key in table "tech_book" mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found "fk_author_id"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD CONSTRAINT wlwflloczhmazamdotbibvqrrzyhmvkslvyzpmlmxt FOREIGN KEY (author_id) REFERENCES author (id)
- changeType: 1
- want:
- - status: 2
- code: 305
- title: naming.index.fk
- content: Foreign key in table "tech_book" mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found "wlwflloczhmazamdotbibvqrrzyhmvkslvyzpmlmxt"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD COLUMN author_id INT CONSTRAINT fk_tech_book_author_id_author_id REFERENCES author (id)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD COLUMN author_id INT CONSTRAINT fk_author_id REFERENCES author (id)
- changeType: 1
- want:
- - status: 2
- code: 305
- title: naming.index.fk
- content: Foreign key in table "tech_book" mismatches the naming convention, expect "^$|^fk_tech_book_author_id_author_id$" but found "fk_author_id"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT, author_id INT, CONSTRAINT fk_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id))
- changeType: 1
-- statement: CREATE TABLE book(id INT, author_id INT, CONSTRAINT fk_book_author_id FOREIGN KEY (author_id) REFERENCES author (id))
- changeType: 1
- want:
- - status: 2
- code: 305
- title: naming.index.fk
- content: Foreign key in table "book" mismatches the naming convention, expect "^$|^fk_book_author_id_author_id$" but found "fk_book_author_id"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT, author_id INT CONSTRAINT fk_book_author_id_author_id REFERENCES author (id))
- changeType: 1
-- statement: |-
- -- this is the first line.
- CREATE TABLE book(
- id INT,
- author_id INT CONSTRAINT fk_book_author_id REFERENCES author (id)
- )
- changeType: 1
- want:
- - status: 2
- code: 305
- title: naming.index.fk
- content: Foreign key in table "book" mismatches the naming convention, expect "^$|^fk_book_author_id_author_id$" but found "fk_book_author_id"
- startposition:
- line: 4
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/naming_index_idx.yaml b/backend/plugin/advisor/pg/test/naming_index_idx.yaml
deleted file mode 100644
index 55040616e3..0000000000
--- a/backend/plugin/advisor/pg/test/naming_index_idx.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-- statement: CREATE INDEX idx_tech_book_id_name ON tech_book(id, name)
- changeType: 1
-- statement: CREATE INDEX tech_book_id_name ON tech_book(id, name)
- changeType: 1
- want:
- - status: 2
- code: 303
- title: naming.index.idx
- content: Index in table "tech_book" mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found "tech_book_id_name"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE INDEX wfdtqyetsyoovcvikjlyfukxyjxxxhifl ON tech_book(id, name)
- changeType: 1
- want:
- - status: 2
- code: 303
- title: naming.index.idx
- content: Index in table "tech_book" mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found "wfdtqyetsyoovcvikjlyfukxyjxxxhifl"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER INDEX old_index RENAME TO idx_tech_book_id_name
- changeType: 1
-- statement: ALTER INDEX old_index RENAME TO idx_tech_book
- changeType: 1
- want:
- - status: 2
- code: 303
- title: naming.index.idx
- content: Index in table "tech_book" mismatches the naming convention, expect "^$|^idx_tech_book_id_name$" but found "idx_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/naming_index_pk.yaml b/backend/plugin/advisor/pg/test/naming_index_pk.yaml
deleted file mode 100644
index 6e9faff391..0000000000
--- a/backend/plugin/advisor/pg/test/naming_index_pk.yaml
+++ /dev/null
@@ -1,86 +0,0 @@
-- statement: ALTER TABLE tech_book ADD CONSTRAINT pk_tech_book_id_name PRIMARY KEY (id, name)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT tech_book_id_name PRIMARY KEY (id, name)
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "tech_book" mismatches the naming convention, expect "^$|^pk_tech_book_id_name$" but found "tech_book_id_name"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD CONSTRAINT udmhjtnsaablcmjhqcznfiwtnevcehcvw PRIMARY KEY (id, name)
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "tech_book" mismatches the naming convention, expect "^$|^pk_tech_book_id_name$" but found "udmhjtnsaablcmjhqcznfiwtnevcehcvw"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT, name VARCHAR(20), CONSTRAINT pk_book_name PRIMARY KEY (name))
- changeType: 1
-- statement: |-
- -- this is the first line.
- CREATE TABLE book(
- id INT,
- name VARCHAR(20),
- CONSTRAINT tech_book_name PRIMARY KEY (name)
- )
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "book" mismatches the naming convention, expect "^$|^pk_book_name$" but found "tech_book_name"
- startposition:
- line: 5
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT, name VARCHAR(20), PRIMARY KEY (name))
- changeType: 1
-- statement: CREATE TABLE book(id INT, name VARCHAR(20) PRIMARY KEY)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT pk_tech_book_id_name PRIMARY KEY USING INDEX old_index
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT pk_tech_book PRIMARY KEY USING INDEX old_index
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "tech_book" mismatches the naming convention, expect "^$|^pk_tech_book_id_name$" but found "pk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book RENAME CONSTRAINT old_pk TO pk_tech_book_id_name
- changeType: 1
-- statement: ALTER TABLE tech_book RENAME CONSTRAINT old_pk TO pk_tech_book
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "tech_book" mismatches the naming convention, expect "^$|^pk_tech_book_id_name$" but found "pk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER INDEX old_pk RENAME TO pk_tech_book_id_name
- changeType: 1
-- statement: ALTER INDEX old_pk RENAME TO pk_tech_book
- changeType: 1
- want:
- - status: 2
- code: 306
- title: naming.index.pk
- content: Primary key in table "tech_book" mismatches the naming convention, expect "^$|^pk_tech_book_id_name$" but found "pk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/naming_index_uk.yaml b/backend/plugin/advisor/pg/test/naming_index_uk.yaml
deleted file mode 100644
index 247f5c6ac6..0000000000
--- a/backend/plugin/advisor/pg/test/naming_index_uk.yaml
+++ /dev/null
@@ -1,99 +0,0 @@
-- statement: CREATE UNIQUE INDEX uk_tech_book_id_name ON tech_book(id, name)
- changeType: 1
-- statement: CREATE UNIQUE INDEX tech_book_id_name ON tech_book(id, name)
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "tech_book_id_name"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE UNIQUE INDEX dzfzqbhnkiiegdhvqjeqoevesfuwcmokrehxlapoqj ON tech_book(id, name)
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "dzfzqbhnkiiegdhvqjeqoevesfuwcmokrehxlapoqj"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD CONSTRAINT uk_tech_book_id_name UNIQUE (id, name)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT tech_book_id_name UNIQUE (id, name)
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "tech_book_id_name"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT PRIMARY KEY, name VARCHAR(20), CONSTRAINT uk_book_name UNIQUE (name))
- changeType: 1
-- statement: |-
- -- this is the first line.
- CREATE TABLE book(
- id INT PRIMARY KEY,
- name VARCHAR(20),
- CONSTRAINT book_name UNIQUE (name)
- )
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "book" mismatches the naming convention, expect "^$|^uk_book_name$" but found "book_name"
- startposition:
- line: 5
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT PRIMARY KEY, name VARCHAR(20), UNIQUE (name))
- changeType: 1
-- statement: CREATE TABLE book(id INT PRIMARY KEY, name VARCHAR(20) UNIQUE)
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT uk_tech_book_id_name UNIQUE USING INDEX old_index
- changeType: 1
-- statement: ALTER TABLE tech_book ADD CONSTRAINT uk_tech_book UNIQUE USING INDEX old_index
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "uk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book RENAME CONSTRAINT old_uk TO uk_tech_book_id_name
- changeType: 1
-- statement: ALTER TABLE tech_book RENAME CONSTRAINT old_uk TO uk_tech_book
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "uk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER INDEX old_uk RENAME TO uk_tech_book_id_name
- changeType: 1
-- statement: ALTER INDEX old_uk RENAME TO uk_tech_book
- changeType: 1
- want:
- - status: 2
- code: 304
- title: naming.index.uk
- content: Unique key in table "tech_book" mismatches the naming convention, expect "^$|^uk_tech_book_id_name$" but found "uk_tech_book"
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/naming_table.yaml b/backend/plugin/advisor/pg/test/naming_table.yaml
deleted file mode 100644
index 05d68fb8ac..0000000000
--- a/backend/plugin/advisor/pg/test/naming_table.yaml
+++ /dev/null
@@ -1,64 +0,0 @@
-- statement: CREATE TABLE "techBook"(id int, name varchar(255))
- changeType: 1
- want:
- - status: 2
- code: 301
- title: naming.table
- content: '"techBook" mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE "rlcmidzlevbivwvcntihenpoibtiutqeb"(id int, name varchar(255))
- changeType: 1
-- statement: CREATE TABLE _techBook(id int, name varchar(255))
- changeType: 1
- want:
- - status: 2
- code: 301
- title: naming.table
- content: '"_techbook" mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE techBook(id int, name varchar(255))
- changeType: 1
-- statement: CREATE TABLE book(id int, name varchar(255))
- changeType: 1
-- statement: ALTER TABLE tech_book RENAME TO "TechBook"
- changeType: 1
- want:
- - status: 2
- code: 301
- title: naming.table
- content: '"TechBook" mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- create table techBook(id int);
- ALTER TABLE techBook RENAME TO tech_book_tmp;
- changeType: 1
-- statement: |-
- CREATE TABLE _techBook(id int, name varchar(255));
- ALTER TABLE tech_book RENAME TO "TechBook";
- changeType: 1
- want:
- - status: 2
- code: 301
- title: naming.table
- content: '"_techbook" mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 1
- column: 0
- endposition: null
- - status: 2
- code: 301
- title: naming.table
- content: '"TechBook" mismatches table naming convention, naming format should be "^[a-z]+(_[a-z]+)*$"'
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/schema_backward_compatibility.yaml b/backend/plugin/advisor/pg/test/schema_backward_compatibility.yaml
deleted file mode 100644
index 5634d89b14..0000000000
--- a/backend/plugin/advisor/pg/test/schema_backward_compatibility.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-- statement: ALTER TABLE tech_book ALTER COLUMN name TYPE TEXT
- changeType: 1
- want:
- - status: 2
- code: 111
- title: schema.backward-compatibility
- content: '"ALTER TABLE tech_book ALTER COLUMN name TYPE TEXT" may cause incompatibility with the existing data and code'
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_add_check_not_valid.yaml b/backend/plugin/advisor/pg/test/statement_add_check_not_valid.yaml
deleted file mode 100644
index db79c3a467..0000000000
--- a/backend/plugin/advisor/pg/test/statement_add_check_not_valid.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: alter table tech_book add constraint check_id check(id > 0);
- changeType: 1
- want:
- - status: 2
- code: 211
- title: statement.add-check-not-valid
- content: Adding check constraints with validation will block reads and writes. You can add check constraints not valid and then validate separately
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: alter table tech_book add constraint check_id check(id > 0) NOT VALID;
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_add_foreign_key_not_valid.yaml b/backend/plugin/advisor/pg/test/statement_add_foreign_key_not_valid.yaml
deleted file mode 100644
index 9fe5e326c4..0000000000
--- a/backend/plugin/advisor/pg/test/statement_add_foreign_key_not_valid.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-- statement: |-
- CREATE TABLE task (
- id SERIAL PRIMARY KEY,
- row_status row_status NOT NULL DEFAULT 'NORMAL',
- name TEXT NOT NULL
- );
- CREATE TABLE task_run (
- id SERIAL PRIMARY KEY,
- task_id INTEGER NOT NULL,
- name TEXT NOT NULL,
- result JSONB NOT NULL DEFAULT '{}'
- );
- ALTER TABLE task_run ADD CONSTRAINT task_run_task_id_fk_task_id FOREIGN KEY (task_id) REFERENCES task (id);
- changeType: 1
- want:
- - status: 2
- code: 229
- title: statement.add-foreign-key-not-valid
- content: Adding foreign keys with validation will block reads and writes. You can add check foreign keys not valid and then validate separately
- startposition:
- line: 12
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE task (
- id SERIAL PRIMARY KEY,
- row_status row_status NOT NULL DEFAULT 'NORMAL',
- name TEXT NOT NULL
- );
- CREATE TABLE task_run (
- id SERIAL PRIMARY KEY,
- task_id INTEGER NOT NULL,
- name TEXT NOT NULL,
- result JSONB NOT NULL DEFAULT '{}'
- );
- ALTER TABLE task_run ADD CONSTRAINT task_run_task_id_fk_task_id FOREIGN KEY (task_id) REFERENCES task (id) NOT VALID;
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_affected_row_limit.yaml b/backend/plugin/advisor/pg/test/statement_affected_row_limit.yaml
deleted file mode 100644
index 1adfbe25f1..0000000000
--- a/backend/plugin/advisor/pg/test/statement_affected_row_limit.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
-- statement: DELETE FROM tech_book WHERE a > 1
- changeType: 1
-- statement: UPDATE tech_book SET id = 1
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_check_set_role_variable.yaml b/backend/plugin/advisor/pg/test/statement_check_set_role_variable.yaml
deleted file mode 100644
index 0e76beb7a9..0000000000
--- a/backend/plugin/advisor/pg/test/statement_check_set_role_variable.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-- statement: SET SESSION ROLE joe; SELECT * FROM t
- changeType: 1
-- statement: INSERT INTO t (id) VALUES (1);
- changeType: 2
- want:
- - status: 2
- code: 217
- title: statement.check-set-role-variable
- content: No SET ROLE statement found.
- startposition: null
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_create_specify_schema.yaml b/backend/plugin/advisor/pg/test/statement_create_specify_schema.yaml
deleted file mode 100644
index 0e2c765b41..0000000000
--- a/backend/plugin/advisor/pg/test/statement_create_specify_schema.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: CREATE TABLE t(id int);
- changeType: 1
- want:
- - status: 2
- code: 216
- title: statement.create-specify-schema
- content: Table schema should be specified.
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE public.t(id int);
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_add_column_with_default.yaml b/backend/plugin/advisor/pg/test/statement_disallow_add_column_with_default.yaml
deleted file mode 100644
index 758055fbf9..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_add_column_with_default.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: ALTER TABLE tech_book ADD COLUMN c int;
- changeType: 1
-- statement: ALTER TABLE tech_book ADD COLUMN c int DEFAULT 0;
- changeType: 1
- want:
- - status: 2
- code: 210
- title: statement.disallow-add-column-with-default
- content: Adding column with DEFAULT will locked the whole table and rewriting each rows
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_add_not_null.yaml b/backend/plugin/advisor/pg/test/statement_disallow_add_not_null.yaml
deleted file mode 100644
index 516692b1c8..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_add_not_null.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-- statement: alter table tech_book alter column name set not null;
- changeType: 1
- want:
- - status: 2
- code: 212
- title: statement.disallow-add-not-null
- content: Setting NOT NULL will block reads and writes. You can use CHECK ("name" IS NOT NULL) instead
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- alter table tech_book add constraint check_name_not_null check(name IS NOT NULL) NOT VALID;
- alter table tech_book validate constraint check_name_not_null;
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_commit.yaml b/backend/plugin/advisor/pg/test/statement_disallow_commit.yaml
deleted file mode 100644
index 58b8b737c7..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_commit.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-- statement: |-
- START TRANSACTION;
- CREATE TABLE techBook(id int, name varchar(255));
- COMMIT;
- changeType: 1
- want:
- - status: 2
- code: 206
- title: statement.disallow-commit
- content: 'Commit is not allowed, related statement: "COMMIT;"'
- startposition:
- line: 3
- column: 0
- endposition: null
-- statement: |-
- START TRANSACTION;
- CREATE TABLE techBook(id int, name varchar(255));
- COMMIT;
-
- START TRANSACTION;
- INSERT INTO techBook(id, name) VALUES(1, "book");
- COMMIT;
- changeType: 1
- want:
- - status: 2
- code: 206
- title: statement.disallow-commit
- content: 'Commit is not allowed, related statement: "COMMIT;"'
- startposition:
- line: 3
- column: 0
- endposition: null
- - status: 2
- code: 206
- title: statement.disallow-commit
- content: 'Commit is not allowed, related statement: "COMMIT;"'
- startposition:
- line: 7
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_mix_in_ddl.yaml b/backend/plugin/advisor/pg/test/statement_disallow_mix_in_ddl.yaml
deleted file mode 100644
index 70e3e82b33..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_mix_in_ddl.yaml
+++ /dev/null
@@ -1,41 +0,0 @@
-- statement: DELETE FROM tech_book WHERE a > 1;
- changeType: 1
- want:
- - status: 2
- code: 227
- title: statement.disallow-mix-in-ddl
- content: Alter schema can only run DDL, "DELETE FROM tech_book WHERE a > 1;" is not DDL
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: UPDATE tech_book SET id = 1;
- changeType: 1
- want:
- - status: 2
- code: 227
- title: statement.disallow-mix-in-ddl
- content: Alter schema can only run DDL, "UPDATE tech_book SET id = 1;" is not DDL
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD COLUMN author TEXT; UPDATE tech_book SET id = 1;DELETE FROM tech_book WHERE a > 1;
- changeType: 1
- want:
- - status: 2
- code: 227
- title: statement.disallow-mix-in-ddl
- content: Alter schema can only run DDL, "DELETE FROM tech_book WHERE a > 1;" is not DDL
- startposition:
- line: 1
- column: 0
- endposition: null
- - status: 2
- code: 227
- title: statement.disallow-mix-in-ddl
- content: Alter schema can only run DDL, "UPDATE tech_book SET id = 1;" is not DDL
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_mix_in_dml.yaml b/backend/plugin/advisor/pg/test/statement_disallow_mix_in_dml.yaml
deleted file mode 100644
index 3c10935ca0..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_mix_in_dml.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-- statement: DELETE FROM tech_book WHERE a > 1;
- changeType: 2
-- statement: UPDATE tech_book SET id = 1;
- changeType: 2
-- statement: ALTER TABLE tech_book ADD COLUMN author TEXT; UPDATE tech_book SET id = 1;DELETE FROM tech_book WHERE a > 1;
- changeType: 2
- want:
- - status: 2
- code: 227
- title: statement.disallow-mix-in-dml
- content: Data change can only run DML, "ALTER TABLE tech_book ADD COLUMN author TEXT;" is not DML
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_on_del_cascade.yaml b/backend/plugin/advisor/pg/test/statement_disallow_on_del_cascade.yaml
deleted file mode 100644
index c857849dd3..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_on_del_cascade.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-- statement: TRUNCATE TABLE issues CASCADE;
- changeType: 1
-- statement: |-
- CREATE TABLE users (
- tenant_id integer REFERENCES tenants ON DELETE CASCADE,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- changeType: 1
- want:
- - status: 2
- code: 213
- title: statement.disallow-on-del-cascade
- content: The CASCADE option is not permitted for ON DELETE clauses
- startposition:
- line: 1
- column: 1
- endposition: null
-- statement: |-
- CREATE TABLE users (
- tenant_id integer,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- COMMENT ON TABLE users IS 'CASCADE COMMENT';
- changeType: 1
-- statement: |-
- TRUNCATE TABLE tech_book CASCADE;
- DROP TABLE tech_book CASCADE;
- CREATE TABLE users (
- tenant_id integer REFERENCES tenants ON DELETE CASCADE,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- changeType: 1
- want:
- - status: 2
- code: 213
- title: statement.disallow-on-del-cascade
- content: The CASCADE option is not permitted for ON DELETE clauses
- startposition:
- line: 2
- column: 1
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_disallow_rm_tbl_cascade.yaml b/backend/plugin/advisor/pg/test/statement_disallow_rm_tbl_cascade.yaml
deleted file mode 100644
index e0b22c910e..0000000000
--- a/backend/plugin/advisor/pg/test/statement_disallow_rm_tbl_cascade.yaml
+++ /dev/null
@@ -1,52 +0,0 @@
-- statement: TRUNCATE TABLE issues CASCADE;
- changeType: 1
- want:
- - status: 2
- code: 213
- title: statement.disallow-rm-tbl-cascade
- content: The use of CASCADE is not permitted when removing a table
- startposition:
- line: 1
- column: 1
- endposition: null
-- statement: |-
- CREATE TABLE users (
- tenant_id integer REFERENCES tenants ON DELETE CASCADE,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- changeType: 1
-- statement: |-
- CREATE TABLE users (
- tenant_id integer,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- COMMENT ON TABLE users IS 'CASCADE COMMENT';
- changeType: 1
-- statement: |-
- TRUNCATE TABLE tech_book CASCADE;
- DROP TABLE tech_book CASCADE;
- CREATE TABLE users (
- tenant_id integer REFERENCES tenants ON DELETE CASCADE,
- user_id integer NOT NULL,
- PRIMARY KEY (tenant_id, user_id)
- );
- changeType: 1
- want:
- - status: 2
- code: 213
- title: statement.disallow-rm-tbl-cascade
- content: The use of CASCADE is not permitted when removing a table
- startposition:
- line: 1
- column: 1
- endposition: null
- - status: 2
- code: 213
- title: statement.disallow-rm-tbl-cascade
- content: The use of CASCADE is not permitted when removing a table
- startposition:
- line: 1
- column: 1
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_dml_dry_run.yaml b/backend/plugin/advisor/pg/test/statement_dml_dry_run.yaml
deleted file mode 100644
index 291d9d0089..0000000000
--- a/backend/plugin/advisor/pg/test/statement_dml_dry_run.yaml
+++ /dev/null
@@ -1,4 +0,0 @@
-- statement: INSERT INTO tech_book values(1, 'a')
- changeType: 1
-- statement: DELETE FROM tech_book
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_insert_disallow_order_by_rand.yaml b/backend/plugin/advisor/pg/test/statement_insert_disallow_order_by_rand.yaml
deleted file mode 100644
index 1a68ee82e8..0000000000
--- a/backend/plugin/advisor/pg/test/statement_insert_disallow_order_by_rand.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: INSERT INTO tech_book VALUES(1, "a")
- changeType: 1
-- statement: INSERT INTO tech_book SELECT * FROM tech_book ORDER BY random()
- changeType: 1
- want:
- - status: 2
- code: 1108
- title: statement.insert.disallow-order-by-rand
- content: The INSERT statement uses ORDER BY random() or random_between(), related statement "INSERT INTO tech_book SELECT * FROM tech_book ORDER BY random()"
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_insert_must_specify_column.yaml b/backend/plugin/advisor/pg/test/statement_insert_must_specify_column.yaml
deleted file mode 100644
index b089a7fc59..0000000000
--- a/backend/plugin/advisor/pg/test/statement_insert_must_specify_column.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-- statement: INSERT INTO tech_book(id, name) VALUES (1, '1')
- changeType: 1
-- statement: INSERT INTO tech_book VALUES (1, '1')
- changeType: 1
- want:
- - status: 2
- code: 1107
- title: statement.insert.must-specify-column
- content: The INSERT statement must specify columns but "INSERT INTO tech_book VALUES (1, '1')" does not
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_insert_row_limit.yaml b/backend/plugin/advisor/pg/test/statement_insert_row_limit.yaml
deleted file mode 100644
index ff6a96ce06..0000000000
--- a/backend/plugin/advisor/pg/test/statement_insert_row_limit.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-- statement: INSERT INTO tech_book values(1, 'a')
- changeType: 1
-- statement: INSERT INTO tech_book values(1, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e'), (6, 'f')
- changeType: 1
- want:
- - status: 2
- code: 1101
- title: statement.insert.row-limit
- content: The statement "INSERT INTO tech_book values(1, 'a'), (2, 'b'), (3, 'c'), (4, 'd'), (5, 'e'), (6, 'f')" inserts 6 rows. The count exceeds 5.
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: INSERT INTO tech_book SELECT * FROM tech_book;
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_maximum_limit_value.yaml b/backend/plugin/advisor/pg/test/statement_maximum_limit_value.yaml
deleted file mode 100644
index 3b0124f5ea..0000000000
--- a/backend/plugin/advisor/pg/test/statement_maximum_limit_value.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-- statement: |
- SELECT * FROM employee LIMIT 1000000;
- changeType: 1
- want:
- - status: 2
- code: 222
- title: statement.maximum-limit-value
- content: The limit value 1000000 exceeds the maximum allowed value 1000
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_merge_alter_table.yaml b/backend/plugin/advisor/pg/test/statement_merge_alter_table.yaml
deleted file mode 100644
index 88e5ef986d..0000000000
--- a/backend/plugin/advisor/pg/test/statement_merge_alter_table.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-- statement: ALTER TABLE tech_book ADD COLUMN a int
- changeType: 1
-- statement: |-
- CREATE TABLE t(a int);
- ALTER TABLE tech_book ADD COLUMN a int;
- ALTER TABLE t ADD COLUMN b int;
- changeType: 1
- want:
- - status: 2
- code: 207
- title: statement.merge-alter-table
- content: There are 2 statements to modify table `t`
- startposition:
- line: 3
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_non_transactional.yaml b/backend/plugin/advisor/pg/test/statement_non_transactional.yaml
deleted file mode 100644
index 992f3c9fe3..0000000000
--- a/backend/plugin/advisor/pg/test/statement_non_transactional.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-- statement: CREATE INDEX idx_tech_book_id_name ON tech_book(id, name)
- changeType: 1
-- statement: CREATE INDEX CONCURRENTLY tech_book_id_name ON tech_book(id, name)
- changeType: 1
- want:
- - status: 2
- code: 230
- title: statement.non-transactional
- content: This statement is non-transactional
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: VACUUM FULL tech_book
- changeType: 1
- want:
- - status: 2
- code: 230
- title: statement.non-transactional
- content: This statement is non-transactional
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_select_no_select_all.yaml b/backend/plugin/advisor/pg/test/statement_select_no_select_all.yaml
deleted file mode 100644
index be1d9ece14..0000000000
--- a/backend/plugin/advisor/pg/test/statement_select_no_select_all.yaml
+++ /dev/null
@@ -1,35 +0,0 @@
-- statement: SELECT * FROM t
- changeType: 1
- want:
- - status: 2
- code: 203
- title: statement.select.no-select-all
- content: '"SELECT * FROM t" uses SELECT all'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT a, b FROM t
- changeType: 1
-- statement: SELECT a, b FROM (SELECT * from t1, t2) t
- changeType: 1
- want:
- - status: 2
- code: 203
- title: statement.select.no-select-all
- content: '"SELECT a, b FROM (SELECT * from t1, t2) t" uses SELECT all'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: INSERT INTO t SELECT * FROM t1
- changeType: 1
- want:
- - status: 2
- code: 203
- title: statement.select.no-select-all
- content: '"INSERT INTO t SELECT * FROM t1" uses SELECT all'
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_where_no_leading_wildcard_like.yaml b/backend/plugin/advisor/pg/test/statement_where_no_leading_wildcard_like.yaml
deleted file mode 100644
index 1e2a33d904..0000000000
--- a/backend/plugin/advisor/pg/test/statement_where_no_leading_wildcard_like.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-- statement: SELECT * FROM t WHERE a LIKE 'abc%'
- changeType: 1
-- statement: SELECT * FROM t WHERE a LIKE '%abc'
- changeType: 1
- want:
- - status: 2
- code: 204
- title: statement.where.no-leading-wildcard-like
- content: '"SELECT * FROM t WHERE a LIKE ''%abc''" uses leading wildcard LIKE'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT * FROM t WHERE a LIKE 'abc' OR a LIKE '%abc'
- changeType: 1
- want:
- - status: 2
- code: 204
- title: statement.where.no-leading-wildcard-like
- content: '"SELECT * FROM t WHERE a LIKE ''abc'' OR a LIKE ''%abc''" uses leading wildcard LIKE'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT * FROM t WHERE a LIKE '%acc' OR a LIKE '%abc'
- changeType: 1
- want:
- - status: 2
- code: 204
- title: statement.where.no-leading-wildcard-like
- content: '"SELECT * FROM t WHERE a LIKE ''%acc'' OR a LIKE ''%abc''" uses leading wildcard LIKE'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT * FROM (SELECT * FROM t WHERE a LIKE '%acc' OR a LIKE '%abc') t1
- changeType: 1
- want:
- - status: 2
- code: 204
- title: statement.where.no-leading-wildcard-like
- content: '"SELECT * FROM (SELECT * FROM t WHERE a LIKE ''%acc'' OR a LIKE ''%abc'') t1" uses leading wildcard LIKE'
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/statement_where_require_select.yaml b/backend/plugin/advisor/pg/test/statement_where_require_select.yaml
deleted file mode 100644
index 9d01185a66..0000000000
--- a/backend/plugin/advisor/pg/test/statement_where_require_select.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-- statement: SELECT a FROM t
- changeType: 1
- want:
- - status: 2
- code: 202
- title: statement.where.require.select
- content: '"SELECT a FROM t" requires WHERE clause'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT a FROM t WHERE a > 0
- changeType: 1
-- statement: SELECT a FROM t WHERE a > (SELECT max(id) FROM user)
- changeType: 1
- want:
- - status: 2
- code: 202
- title: statement.where.require.select
- content: '"SELECT a FROM t WHERE a > (SELECT max(id) FROM user)" requires WHERE clause'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: SELECT 1
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/statement_where_require_update_delete.yaml b/backend/plugin/advisor/pg/test/statement_where_require_update_delete.yaml
deleted file mode 100644
index 0feac1472f..0000000000
--- a/backend/plugin/advisor/pg/test/statement_where_require_update_delete.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-- statement: DELETE FROM t1
- changeType: 1
- want:
- - status: 2
- code: 202
- title: statement.where.require.update-delete
- content: '"DELETE FROM t1" requires WHERE clause'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: UPDATE t1 SET a = 1
- changeType: 1
- want:
- - status: 2
- code: 202
- title: statement.where.require.update-delete
- content: '"UPDATE t1 SET a = 1" requires WHERE clause'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: DELETE FROM t1 WHERE a > 0
- changeType: 1
-- statement: UPDATE t1 SET a = 1 WHERE a > 10
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/system_charset_allowlist.yaml b/backend/plugin/advisor/pg/test/system_charset_allowlist.yaml
deleted file mode 100644
index a73f504104..0000000000
--- a/backend/plugin/advisor/pg/test/system_charset_allowlist.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-- statement: CREATE DATABASE test WITH ENCODING 'UTF8'
- changeType: 1
-- statement: CREATE DATABASE test
- changeType: 1
-- statement: CREATE DATABASE test WITH ENCODING 'LATIN1'
- changeType: 1
- want:
- - status: 2
- code: 1001
- title: system.charset.allowlist
- content: '"" used disabled encoding ''latin1'''
- startposition:
- line: 0
- column: 0
- endposition: null
-- statement: /* this is a comment */
- changeType: 1
diff --git a/backend/plugin/advisor/pg/test/system_collation_allowlist.yaml b/backend/plugin/advisor/pg/test/system_collation_allowlist.yaml
deleted file mode 100644
index 7edae7f7c8..0000000000
--- a/backend/plugin/advisor/pg/test/system_collation_allowlist.yaml
+++ /dev/null
@@ -1,35 +0,0 @@
-- statement: CREATE TABLE t(a text COLLATE utf8mb4_0900_ai_ci)
- changeType: 1
-- statement: CREATE TABLE t(a text COLLATE "unknown")
- changeType: 1
- want:
- - status: 2
- code: 1201
- title: system.collation.allowlist
- content: Use disabled collation "unknown", related statement "CREATE TABLE t(a text COLLATE "unknown")"
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ADD COLUMN c1 text COLLATE "unknown"
- changeType: 1
- want:
- - status: 2
- code: 1201
- title: system.collation.allowlist
- content: Use disabled collation "unknown", related statement "ALTER TABLE tech_book ADD COLUMN c1 text COLLATE "unknown""
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ALTER COLUMN id TYPE text COLLATE "unknown"
- changeType: 1
- want:
- - status: 2
- code: 1201
- title: system.collation.allowlist
- content: Use disabled collation "unknown", related statement "ALTER TABLE tech_book ALTER COLUMN id TYPE text COLLATE "unknown""
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/system_comment_length.yaml b/backend/plugin/advisor/pg/test/system_comment_length.yaml
deleted file mode 100644
index 1718cdfdb7..0000000000
--- a/backend/plugin/advisor/pg/test/system_comment_length.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-- statement: comment on column public.name is 'is a column name'
- changeType: 1
-- statement: comment on column public.name is 'is a to long column name'
- changeType: 1
- want:
- - status: 2
- code: 1301
- title: system.comment.length
- content: The length of comment should be within 20 characters
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: comment on table public is 'is a table name'
- changeType: 1
-- statement: comment on table public is 'is a to long table name long long long long long long long'
- changeType: 1
- want:
- - status: 2
- code: 1301
- title: system.comment.length
- content: The length of comment should be within 20 characters
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/table_comment.yaml b/backend/plugin/advisor/pg/test/table_comment.yaml
deleted file mode 100644
index 261c7e3a64..0000000000
--- a/backend/plugin/advisor/pg/test/table_comment.yaml
+++ /dev/null
@@ -1,70 +0,0 @@
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON TABLE t IS 'comments';
- changeType: 1
-- statement: CREATE TABLE t(a int);
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: table.comment
- content: Comment is required for table `t`
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- CREATE TABLE d(a int);
- COMMENT ON TABLE t IS 'comments';
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: table.comment
- content: Comment is required for table `d`
- startposition:
- line: 2
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON TABLE t IS 'comments';
- COMMENT ON TABLE t IS '';
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: table.comment
- content: Comment is required for table `t`
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON TABLE t IS 'comments';
- COMMENT ON TABLE t IS NULL;
- changeType: 1
- want:
- - status: 2
- code: 1032
- title: table.comment
- content: Comment is required for table `t`
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- CREATE TABLE t(a int);
- COMMENT ON TABLE t IS 'looooooong comments';
- changeType: 1
- want:
- - status: 2
- code: 1301
- title: table.comment
- content: Table `t` comment is too long. The length of comment should be within 10 characters
- startposition:
- line: 2
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/table_disallow_partition.yaml b/backend/plugin/advisor/pg/test/table_disallow_partition.yaml
deleted file mode 100644
index fe50b1ebe2..0000000000
--- a/backend/plugin/advisor/pg/test/table_disallow_partition.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-- statement: CREATE TABLE t(a int)
- changeType: 1
-- statement: CREATE TABLE t(a int) PARTITION BY RANGE (a);
- changeType: 1
- want:
- - status: 2
- code: 608
- title: table.disallow-partition
- content: Table partition is forbidden, but "CREATE TABLE t(a int) PARTITION BY RANGE (a);" creates
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE tech_book ATTACH PARTITION p1 DEFAULT;
- changeType: 1
- want:
- - status: 2
- code: 608
- title: table.disallow-partition
- content: Table partition is forbidden, but "ALTER TABLE tech_book ATTACH PARTITION p1 DEFAULT;" creates
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/table_drop_naming_convention.yaml b/backend/plugin/advisor/pg/test/table_drop_naming_convention.yaml
deleted file mode 100644
index 7dd7f76328..0000000000
--- a/backend/plugin/advisor/pg/test/table_drop_naming_convention.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-- statement: DROP TABLE IF EXISTS foo_delete
- changeType: 1
-- statement: DROP TABLE IF EXISTS foo
- changeType: 1
- want:
- - status: 2
- code: 603
- title: table.drop-naming-convention
- content: '`foo` mismatches drop table naming convention, naming format should be "_delete$"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: DROP TABLE IF EXISTS foo_delete, bar
- changeType: 1
- want:
- - status: 2
- code: 603
- title: table.drop-naming-convention
- content: '`bar` mismatches drop table naming convention, naming format should be "_delete$"'
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/table_no_foreign_key.yaml b/backend/plugin/advisor/pg/test/table_no_foreign_key.yaml
deleted file mode 100644
index acf0effa26..0000000000
--- a/backend/plugin/advisor/pg/test/table_no_foreign_key.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-- statement: ALTER TABLE tech_book ADD CONSTRAINT fk_tech_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id)
- changeType: 1
- want:
- - status: 2
- code: 602
- title: table.no-foreign-key
- content: 'Foreign key is not allowed in the table "public"."tech_book", related statement: "ALTER TABLE tech_book ADD CONSTRAINT fk_tech_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id)"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: CREATE TABLE book(id INT, author_id INT, CONSTRAINT fk_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id))
- changeType: 1
- want:
- - status: 2
- code: 602
- title: table.no-foreign-key
- content: 'Foreign key is not allowed in the table "public"."book", related statement: "CREATE TABLE book(id INT, author_id INT, CONSTRAINT fk_book_author_id_author_id FOREIGN KEY (author_id) REFERENCES author (id))"'
- startposition:
- line: 1
- column: 0
- endposition: null
diff --git a/backend/plugin/advisor/pg/test/table_require_pk.yaml b/backend/plugin/advisor/pg/test/table_require_pk.yaml
deleted file mode 100644
index 0aa06e7cee..0000000000
--- a/backend/plugin/advisor/pg/test/table_require_pk.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-- statement: CREATE TABLE t(id INT PRIMARY KEY)
- changeType: 1
-- statement: CREATE TABLE t(id INT, PRIMARY KEY (id))
- changeType: 1
-- statement: CREATE TABLE t(id INT)
- changeType: 1
- want:
- - status: 2
- code: 601
- title: table.require-pk
- content: 'Table "public"."t" requires PRIMARY KEY, related statement: "CREATE TABLE t(id INT)"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE "tech_book" DROP CONSTRAINT "old_pk"
- changeType: 1
- want:
- - status: 2
- code: 601
- title: table.require-pk
- content: 'Table "public"."tech_book" requires PRIMARY KEY, related statement: "ALTER TABLE \"tech_book\" DROP CONSTRAINT \"old_pk\""'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: ALTER TABLE "tech_book" DROP CONSTRAINT "old_index"
- changeType: 1
-- statement: ALTER TABLE "tech_book" DROP CONSTRAINT constraint_not_in_catalog
- changeType: 1
-- statement: ALTER TABLE "tech_book" DROP COLUMN id
- changeType: 1
- want:
- - status: 2
- code: 601
- title: table.require-pk
- content: 'Table "public"."tech_book" requires PRIMARY KEY, related statement: "ALTER TABLE \"tech_book\" DROP COLUMN id"'
- startposition:
- line: 1
- column: 0
- endposition: null
-- statement: |-
- ALTER TABLE tech_book ADD COLUMN column_not_in_pk int;
- ALTER TABLE "tech_book" DROP COLUMN column_not_in_pk;
- changeType: 1
diff --git a/backend/plugin/advisor/pg/utils.go b/backend/plugin/advisor/pg/utils.go
deleted file mode 100644
index 94349f753d..0000000000
--- a/backend/plugin/advisor/pg/utils.go
+++ /dev/null
@@ -1,56 +0,0 @@
-// Package pg implements the SQL advisor rules for PostgreSQL.
-package pg
-
-import (
- "fmt"
-
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
-)
-
-const (
- // PostgreSQLPublicSchema is the string for PostgreSQL public schema.
- PostgreSQLPublicSchema = "public"
-)
-
-type columnName struct {
- schema string
- table string
- column string
-}
-
-func (c columnName) normalizeTableName() string {
- schema := c.schema
- if schema == "" {
- schema = "public"
- }
- return fmt.Sprintf(`"%s"."%s"`, schema, c.table)
-}
-
-type columnMap map[columnName]int
-
-func normalizeSchemaName(name string) string {
- if name != "" {
- return name
- }
- return "public"
-}
-
-func normalizeTableName(table *ast.TableDef) string {
- schema := table.Schema
-
- if schema == "" {
- return fmt.Sprintf("%q", table.Name)
- }
- return fmt.Sprintf("%q.%q", schema, table.Name)
-}
-
-// newPositionAtLineStart creates a Position at the start of the given line.
-// The line number is used as-is (typically from PostgreSQL parser which uses
-// 0-based line numbers), and column is set to 0.
-func newPositionAtLineStart(line int) *storepb.Position {
- return &storepb.Position{
- Line: int32(line),
- Column: 0,
- }
-}
diff --git a/backend/plugin/parser/pg/legacy/parser.go b/backend/plugin/parser/pg/legacy/parser.go
index 94143ac375..db5929f469 100644
--- a/backend/plugin/parser/pg/legacy/parser.go
+++ b/backend/plugin/parser/pg/legacy/parser.go
@@ -15,9 +15,10 @@ import (
"github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
)
-func init() {
- base.RegisterParseFunc(storepb.Engine_POSTGRES, parsePostgresForRegistry)
-}
+// Disabled legacy parser registration - now using ANTLR parser
+// func init() {
+// base.RegisterParseFunc(storepb.Engine_POSTGRES, parsePostgresForRegistry)
+// }
// parsePostgresForRegistry is the ParseFunc for PostgreSQL.
// Returns []ast.Node (github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast) on success.
diff --git a/backend/plugin/parser/pg/legacy/parser_test.go b/backend/plugin/parser/pg/legacy/parser_test.go
index c4e6140203..0a53f47b20 100644
--- a/backend/plugin/parser/pg/legacy/parser_test.go
+++ b/backend/plugin/parser/pg/legacy/parser_test.go
@@ -5,7 +5,6 @@ import (
"github.com/stretchr/testify/require"
- storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
)
@@ -150,51 +149,3 @@ SELECT * FROM t2;`,
})
}
}
-
-func TestParsePostgresErrorLine(t *testing.T) {
- // Test that error line numbers are correctly reported in SyntaxError
- tests := []struct {
- name string
- statement string
- expectedLine int32
- }{
- {
- name: "single statement error",
- statement: "SELECT * FRAM t1;",
- expectedLine: 1,
- },
- {
- name: "second statement error",
- statement: `SELECT 1;
-SELECT * FRAM t2;`,
- expectedLine: 2,
- },
- {
- name: "third statement error",
- statement: `SELECT 1;
-SELECT 2;
-SELECT * FRAM t3;`,
- expectedLine: 3,
- },
- {
- name: "error in multi-line statement",
- statement: `SELECT
- 1,
- 2
-FRAM t1;`,
- expectedLine: 4,
- },
- }
-
- for _, test := range tests {
- t.Run(test.name, func(t *testing.T) {
- _, err := base.Parse(storepb.Engine_POSTGRES, test.statement)
- require.Error(t, err)
- syntaxErr, ok := err.(*base.SyntaxError)
- require.True(t, ok, "expected *base.SyntaxError, got %T", err)
- require.NotNil(t, syntaxErr.Position)
- require.Equal(t, test.expectedLine, syntaxErr.Position.Line,
- "incorrect error line for statement:\n%s", test.statement)
- })
- }
-}
diff --git a/backend/plugin/parser/pg/parser_integration_test.go b/backend/plugin/parser/pg/parser_integration_test.go
new file mode 100644
index 0000000000..111f50e3e5
--- /dev/null
+++ b/backend/plugin/parser/pg/parser_integration_test.go
@@ -0,0 +1,59 @@
+package pg
+
+import (
+ "testing"
+
+ "github.com/stretchr/testify/require"
+
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
+ "github.com/bytebase/bytebase/backend/plugin/parser/base"
+)
+
+// TestParsePostgresErrorLine tests that the ANTLR parser correctly reports error line numbers.
+// This test is in the pg package (not pg/legacy) to ensure the ANTLR parser is registered via init().
+func TestParsePostgresErrorLine(t *testing.T) {
+ tests := []struct {
+ name string
+ statement string
+ expectedLine int32
+ }{
+ {
+ name: "single statement error",
+ statement: "SELECT * FRAM t1;",
+ expectedLine: 1,
+ },
+ {
+ name: "second statement error",
+ statement: `SELECT 1;
+SELECT * FRAM t2;`,
+ expectedLine: 2,
+ },
+ {
+ name: "third statement error",
+ statement: `SELECT 1;
+SELECT 2;
+SELECT * FRAM t3;`,
+ expectedLine: 3,
+ },
+ {
+ name: "error in multi-line statement",
+ statement: `SELECT
+ 1,
+ 2
+FRAM t1;`,
+ expectedLine: 4,
+ },
+ }
+
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ _, err := base.Parse(storepb.Engine_POSTGRES, test.statement)
+ require.Error(t, err)
+ syntaxErr, ok := err.(*base.SyntaxError)
+ require.True(t, ok, "expected *base.SyntaxError, got %T", err)
+ require.NotNil(t, syntaxErr.Position)
+ require.Equal(t, test.expectedLine, syntaxErr.Position.Line,
+ "incorrect error line for statement:\n%s", test.statement)
+ })
+ }
+}
diff --git a/backend/plugin/parser/pg/pg.go b/backend/plugin/parser/pg/pg.go
index 36c457a58b..01e8f64b2f 100644
--- a/backend/plugin/parser/pg/pg.go
+++ b/backend/plugin/parser/pg/pg.go
@@ -6,9 +6,20 @@ import (
"github.com/antlr4-go/antlr/v4"
parser "github.com/bytebase/parser/postgresql"
+ storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
)
+func init() {
+ base.RegisterParseFunc(storepb.Engine_POSTGRES, parsePostgreSQLForRegistry)
+}
+
+// parsePostgreSQLForRegistry is the ParseFunc for PostgreSQL.
+// Returns *ParseResult containing the ANTLR tree.
+func parsePostgreSQLForRegistry(statement string) (any, error) {
+ return ParsePostgreSQL(statement)
+}
+
type ParseResult struct {
Tree antlr.Tree
Tokens *antlr.CommonTokenStream
diff --git a/backend/plugin/parser/pg/statement_type.go b/backend/plugin/parser/pg/statement_type.go
index f58f511943..c3fdc747be 100644
--- a/backend/plugin/parser/pg/statement_type.go
+++ b/backend/plugin/parser/pg/statement_type.go
@@ -2,8 +2,6 @@ package pg
import (
"github.com/pkg/errors"
-
- "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy/ast"
)
// StatementTypeWithPosition contains statement type and its position information.
@@ -15,153 +13,19 @@ type StatementTypeWithPosition struct {
}
func GetStatementTypes(asts any) ([]string, error) {
- nodes, ok := asts.([]ast.Node)
+ parseResult, ok := asts.(*ParseResult)
if !ok {
- return nil, errors.Errorf("invalid ast type %T", asts)
- }
- sqlTypeSet := make(map[string]bool)
- for _, node := range nodes {
- t := getStatementType(node)
- sqlTypeSet[t] = true
+ return nil, errors.Errorf("invalid ast type %T, expected *ParseResult", asts)
}
- var sqlTypes []string
- for sqlType := range sqlTypeSet {
- sqlTypes = append(sqlTypes, sqlType)
- }
- return sqlTypes, nil
+ return GetStatementTypesANTLR(parseResult)
}
// GetStatementTypesWithPositions returns statement types with position information.
// The line numbers are one-based.
func GetStatementTypesWithPositions(asts any) ([]StatementTypeWithPosition, error) {
- nodes, ok := asts.([]ast.Node)
+ parseResult, ok := asts.(*ParseResult)
if !ok {
- return nil, errors.Errorf("invalid ast type %T", asts)
- }
- var results []StatementTypeWithPosition
- for _, node := range nodes {
- stmtType := getStatementType(node)
- results = append(results, StatementTypeWithPosition{
- Type: stmtType,
- Line: node.LastLine(),
- Text: node.Text(),
- })
- }
- return results, nil
-}
-
-func getStatementType(node ast.Node) string {
- switch node := node.(type) {
- // DDL
-
- // CREATE
- case *ast.CreateIndexStmt:
- return "CREATE_INDEX"
- case *ast.CreateTableStmt:
- switch node.Name.Type {
- case ast.TableTypeView:
- return "CREATE_VIEW"
- case ast.TableTypeBaseTable:
- return "CREATE_TABLE"
- default:
- return "CREATE_TABLE"
- }
- case *ast.CreateSequenceStmt:
- return "CREATE_SEQUENCE"
- case *ast.CreateDatabaseStmt:
- return "CREATE_DATABASE"
- case *ast.CreateSchemaStmt:
- return "CREATE_SCHEMA"
- case *ast.CreateFunctionStmt:
- return "CREATE_FUNCTION"
- case *ast.CreateTriggerStmt:
- return "CREATE_TRIGGER"
- case *ast.CreateTypeStmt:
- return "CREATE_TYPE"
- case *ast.CreateExtensionStmt:
- return "CREATE_EXTENSION"
-
- // DROP
- case *ast.DropColumnStmt:
- return "DROP_COLUMN"
- case *ast.DropConstraintStmt:
- return "DROP_CONSTRAINT"
- case *ast.DropDatabaseStmt:
- return "DROP_DATABASE"
- case *ast.DropDefaultStmt:
- return "DROP_DEFAULT"
- case *ast.DropExtensionStmt:
- return "DROP_EXTENSION"
- case *ast.DropFunctionStmt:
- return "DROP_FUNCTION"
- case *ast.DropIndexStmt:
- return "DROP_INDEX"
- case *ast.DropNotNullStmt:
- return "DROP_NOT_NULL"
- case *ast.DropSchemaStmt:
- return "DROP_SCHEMA"
- case *ast.DropSequenceStmt:
- return "DROP_SEQUENCE"
- case *ast.DropTableStmt:
- return "DROP_TABLE"
- case *ast.DropTriggerStmt:
- return "DROP_TRIGGER"
- case *ast.DropTypeStmt:
- return "DROP_TYPE"
-
- // ALTER
- case *ast.AlterColumnTypeStmt:
- return "ALTER_COLUMN_TYPE"
- case *ast.AlterSequenceStmt:
- return "ALTER_SEQUENCE"
- case *ast.AlterTableStmt:
- switch node.Table.Type {
- case ast.TableTypeView:
- return "ALTER_VIEW"
- case ast.TableTypeBaseTable:
- return "ALTER_TABLE"
- default:
- return "ALTER_TABLE"
- }
- case *ast.AlterTypeStmt:
- return "ALTER_TYPE"
-
- case *ast.AddColumnListStmt:
- return "ALTER_TABLE_ADD_COLUMN_LIST"
- case *ast.AddConstraintStmt:
- return "ALTER_TABLE_ADD_CONSTRAINT"
-
- // RENAME
- case *ast.RenameColumnStmt:
- return "RENAME_COLUMN"
- case *ast.RenameConstraintStmt:
- return "RENAME_CONSTRAINT"
- case *ast.RenameIndexStmt:
- return "RENAME_INDEX"
- case *ast.RenameSchemaStmt:
- return "RENAME_SCHEMA"
- case *ast.RenameTableStmt:
- switch node.Table.Type {
- case ast.TableTypeView:
- return "RENAME_VIEW"
- case ast.TableTypeBaseTable:
- return "RENAME_TABLE"
- default:
- return "RENAME_TABLE"
- }
-
- case *ast.CommentStmt:
- return "COMMENT"
-
- // DML
-
- case *ast.InsertStmt:
- return "INSERT"
- case *ast.UpdateStmt:
- return "UPDATE"
- case *ast.DeleteStmt:
- return "DELETE"
+ return nil, errors.Errorf("invalid ast type %T, expected *ParseResult", asts)
}
-
- return "UNKNOWN"
+ return GetStatementTypesWithPositionsANTLR(parseResult)
}
diff --git a/backend/server/minimal.go b/backend/server/minimal.go
index 155ba701dd..c3a3908093 100644
--- a/backend/server/minimal.go
+++ b/backend/server/minimal.go
@@ -13,10 +13,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/schema/pg"
// Advisors.
- _ "github.com/bytebase/bytebase/backend/plugin/advisor/pg"
-
- // Editors.
- _ "github.com/bytebase/bytebase/backend/plugin/parser/pg/legacy"
+ _ "github.com/bytebase/bytebase/backend/plugin/advisor/pgantlr"
// IM webhooks.
_ "github.com/bytebase/bytebase/backend/plugin/webhook/dingtalk"
diff --git a/backend/server/ultimate.go b/backend/server/ultimate.go
index fd273ee599..04f3ec532c 100644
--- a/backend/server/ultimate.go
+++ b/backend/server/ultimate.go
@@ -34,6 +34,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/parser/elasticsearch"
_ "github.com/bytebase/bytebase/backend/plugin/parser/mysql"
_ "github.com/bytebase/bytebase/backend/plugin/parser/partiql"
+ _ "github.com/bytebase/bytebase/backend/plugin/parser/pg"
_ "github.com/bytebase/bytebase/backend/plugin/parser/plsql"
_ "github.com/bytebase/bytebase/backend/plugin/parser/redis"
_ "github.com/bytebase/bytebase/backend/plugin/parser/redshift"
@@ -48,6 +49,7 @@ import (
_ "github.com/bytebase/bytebase/backend/plugin/advisor/mysql"
_ "github.com/bytebase/bytebase/backend/plugin/advisor/oceanbase"
_ "github.com/bytebase/bytebase/backend/plugin/advisor/oracle"
+ _ "github.com/bytebase/bytebase/backend/plugin/advisor/pgantlr"
_ "github.com/bytebase/bytebase/backend/plugin/advisor/snowflake"
_ "github.com/bytebase/bytebase/backend/plugin/advisor/tidb"
diff --git a/backend/tests/test-data/sql_review_pg.yaml b/backend/tests/test-data/sql_review_pg.yaml
index 75f30702a9..699420d912 100644
--- a/backend/tests/test-data/sql_review_pg.yaml
+++ b/backend/tests/test-data/sql_review_pg.yaml
@@ -24,11 +24,12 @@
{
"status": "ERROR",
"title": "Syntax error",
- "content": "syntax error at or near \"user\"",
+ "content": "Syntax error at line 1:14 \nrelated text: CREATE TABLE user",
"code": 201,
"sqlReviewReport": {
"startPosition": {
- "line": 1
+ "line": 1,
+ "column": 14
}
}
}
@@ -47,11 +48,11 @@
{
"status": "ERROR",
"title": "table.require-pk",
- "content": "Table \"public\".\"userTable\" requires PRIMARY KEY, related statement: \"CREATE TABLE \\\"userTable\\\"(\\n id INT,\\n name VARCHAR(255),\\n \\\"roomId\\\" INT,\\n CONSTRAINT uk1 UNIQUE (id, name),\\n CONSTRAINT fk1 FOREIGN KEY (\\\"roomId\\\") REFERENCES room(id)\\n );\"",
+ "content": "Table \"public\".\"userTable\" requires PRIMARY KEY, related statement: \"CREATE TABLE \\\"userTable\\\"( id INT, name VARCHAR(255), \\\"roomId\\\" INT, CONSTRAINT uk1 UNIQUE (id, name), CONSTRAINT fk1 FOREIGN KEY (\\\"roomId\\\") REFERENCES room(id) );\"",
"code": 601,
"sqlReviewReport": {
"startPosition": {
- "line": 7
+ "line": 1
}
}
}
@@ -59,11 +60,11 @@
{
"status": "ERROR",
"title": "table.no-foreign-key",
- "content": "Foreign key is not allowed in the table \"public\".\"userTable\", related statement: \"CREATE TABLE \"userTable\"(\n id INT,\n name VARCHAR(255),\n \"roomId\" INT,\n CONSTRAINT uk1 UNIQUE (id, name),\n CONSTRAINT fk1 FOREIGN KEY (\"roomId\") REFERENCES room(id)\n );\"",
+ "content": "Foreign key is not allowed in the table \"public\".\"userTable\", related statement: \"CREATE TABLE \"userTable\"( id INT, name VARCHAR(255), \"roomId\" INT, CONSTRAINT uk1 UNIQUE (id, name), CONSTRAINT fk1 FOREIGN KEY (\"roomId\") REFERENCES room(id) );\"",
"code": 602,
"sqlReviewReport": {
"startPosition": {
- "line": 7
+ "line": 1
}
}
}
@@ -75,7 +76,7 @@
"code": 301,
"sqlReviewReport": {
"startPosition": {
- "line": 7
+ "line": 1
}
}
}
@@ -111,7 +112,7 @@
"code": 305,
"sqlReviewReport": {
"startPosition": {
- "line": 6
+ "line": 1
}
}
}
@@ -123,7 +124,7 @@
"code": 401,
"sqlReviewReport": {
"startPosition": {
- "line": 7
+ "line": 1
}
}
}
@@ -241,4 +242,16 @@
}
}
}
+ - |-
+ {
+ "status": "WARNING",
+ "title": "schema.backward-compatibility",
+ "content": "\"ALTER INDEX pk_tech_book_id RENAME TO pk1\" may cause incompatibility with the existing data and code",
+ "code": 102,
+ "sqlReviewReport": {
+ "startPosition": {
+ "line": 1
+ }
+ }
+ }
run: false