Function SQLReviewCheck

backend/plugin/advisor/sql_review.go:93–194

SQLReviewCheck checks the statements with sql review rules.

(
	ctx context.Context,
	sm *sheet.Manager,
	statements string,
	ruleList []*storepb.SQLReviewRule,
	checkContext Context,
)

// SQLReviewCheck checks the statements with sql review rules.
func SQLReviewCheck(
	ctx context.Context,
	sm *sheet.Manager,
	statements string,
	ruleList []*storepb.SQLReviewRule,
	checkContext Context,
) ([]*storepb.Advice, error) {
	stmts, parseResult := sm.GetStatementsForChecks(checkContext.DBType, statements)
	asts := base.ExtractASTs(stmts)

	if !checkContext.NoAppendBuiltin {
		// Append builtin rules only if the user hasn't overridden them in their config.
		userRuleTypes := make(map[storepb.SQLReviewRule_Type]bool, len(ruleList))
		for _, r := range ruleList {
			userRuleTypes[r.Type] = true
		}
		for _, r := range GetBuiltinRules(checkContext.DBType) {
			if !userRuleTypes[r.Type] {
				ruleList = append(ruleList, r)
			}
		}
	}

	if asts == nil || len(ruleList) == 0 {
		return parseResult, nil
	}

	if checkContext.FinalMetadata != nil {
		walkThroughContext := schema.WalkThroughContext{
			SessionUser: checkContext.SessionUser,
			RawSQL:      statements,
		}
		if advice := schema.WalkThroughWithContext(checkContext.DBType, walkThroughContext, checkContext.FinalMetadata, asts); advice != nil {
			for _, rule := range ruleList {
				if rule.Type == storepb.SQLReviewRule_BUILTIN_WALK_THROUGH_CHECK {
					if status, err := NewStatusBySQLReviewRuleLevel(rule.Level); err == nil {
						advice.Status = status
					}
					return []*storepb.Advice{advice}, nil
				}
			}
		}
	}

	// Initialize the per-review memo so engine-specific helpers can amortize
	// work across rules (e.g. omni re-parsing in advisor/tidb). The map header
	// propagates by value across rules; the underlying map is shared.
	checkContext.memo = make(map[string]any)

	var errorAdvices, warningAdvices []*storepb.Advice
	for _, rule := range ruleList {
		if rule.Engine != storepb.Engine_ENGINE_UNSPECIFIED && rule.Engine != checkContext.DBType {
			continue
		}

		ruleType := rule.Type

		// Set per-rule fields