Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
// Package bigquery is the advisor for BigQuery.
package bigquery
import (
"context"
"fmt"
"strings"
omniast "github.com/bytebase/omni/googlesql/ast"
storepb "github.com/bytebase/bytebase/backend/generated-go/store"
"github.com/bytebase/bytebase/backend/plugin/advisor"
"github.com/bytebase/bytebase/backend/plugin/advisor/code"
"github.com/bytebase/bytebase/backend/plugin/parser/base"
// Registers the BigQuery parser so ParseStatements resolves the engine.
_ "github.com/bytebase/bytebase/backend/plugin/parser/bigquery"
"github.com/bytebase/bytebase/backend/plugin/parser/googlesql"
)
var (
_ advisor.Advisor = (*WhereRequireForUpdateDeleteAdvisor)(nil)
)
func init() {
advisor.Register(storepb.Engine_BIGQUERY, storepb.SQLReviewRule_STATEMENT_WHERE_REQUIRE_UPDATE_DELETE, &WhereRequireForUpdateDeleteAdvisor{})
}
// WhereRequireForUpdateDeleteAdvisor is the advisor checking for WHERE clause requirement for UPDATE and DELETE statement.
type WhereRequireForUpdateDeleteAdvisor struct {
}
// Check checks for WHERE clause requirement.
func (*WhereRequireForUpdateDeleteAdvisor) Check(_ context.Context, checkCtx advisor.Context) ([]*storepb.Advice, error) {
level, err := advisor.NewStatusBySQLReviewRuleLevel(checkCtx.Rule.Level)
if err != nil {
return nil, err
}
checker := &whereRequireForUpdateDeleteChecker{
level: level,
title: checkCtx.Rule.Type.String(),
}
for _, stmt := range checkCtx.ParsedStatements {
ast, ok := stmt.AST.(*googlesql.AST)
if !ok || ast.Node == nil {
continue
}
checker.checkStmt(ast.Node, stmt.Text, stmt.BaseLine())
}
return checker.adviceList, nil
}
type whereRequireForUpdateDeleteChecker struct {
adviceList []*storepb.Advice
level storepb.Advice_Status
title string
}
// checkStmt flags UPDATE and DELETE statements without a WHERE clause,
// including those nested in scripts (BEGIN ... END, IF, loops). MERGE
// WHEN ... THEN UPDATE/DELETE actions are separate merge nodes and are not
// flagged.
func (c *whereRequireForUpdateDeleteChecker) checkStmt(node omniast.Node, text string, baseLine int) {
omniast.Inspect(node, func(n omniast.Node) bool {
switch stmt := n.(type) {
case *omniast.UpdateStmt:
if stmt.Where == nil {
c.addAdvice("UPDATE", text, baseLine, stmt.Loc.Start)
}
case *omniast.DeleteStmt:
if stmt.Where == nil {
c.addAdvice("DELETE", text, baseLine, stmt.Loc.Start)
}
default:
}
return true
})
}
func (c *whereRequireForUpdateDeleteChecker) addAdvice(statementType, text string, baseLine, offset int) {
c.adviceList = append(c.adviceList, &storepb.Advice{
Status: c.level,
Code: code.StatementNoWhere.Int32(),
Title: c.title,
Content: fmt.Sprintf("WHERE clause is required for %s statement.", statementType),
StartPosition: base.ConvertANTLRLineToPosition(baseLine + statementLineForOffset(text, offset)),
})
}
// statementLineForOffset returns the 1-based line within text that holds the
// byte offset. An unknown (-1) or out-of-range offset clamps to the text bounds.
func statementLineForOffset(text string, offset int) int {
if offset < 0 {
offset = 0
}
if offset > len(text) {
offset = len(text)
}
return strings.Count(text[:offset], "\n") + 1
}