|
| 1 | +// Copyright 2026 GoSQLX Authors |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +package gosqlx |
| 16 | + |
| 17 | +import ( |
| 18 | + "fmt" |
| 19 | + |
| 20 | + "github.com/ajitpratap0/GoSQLX/pkg/sql/ast" |
| 21 | + "github.com/ajitpratap0/GoSQLX/pkg/sql/parser" |
| 22 | + "github.com/ajitpratap0/GoSQLX/pkg/sql/tokenizer" |
| 23 | +) |
| 24 | + |
| 25 | +// AnalysisResult contains the output of a SQL optimization analysis. |
| 26 | +type AnalysisResult struct { |
| 27 | + // Suggestions contains optimization recommendations. |
| 28 | + Suggestions []AnalysisSuggestion |
| 29 | + |
| 30 | + // QueryComplexity is one of "simple", "moderate", or "complex". |
| 31 | + QueryComplexity string |
| 32 | + |
| 33 | + // Score is 0-100 where 100 means no issues found. |
| 34 | + Score int |
| 35 | +} |
| 36 | + |
| 37 | +// AnalysisSuggestion represents a single optimization recommendation. |
| 38 | +type AnalysisSuggestion struct { |
| 39 | + RuleID string // e.g., "OPT-001" |
| 40 | + Severity string // "info", "warning", or "error" |
| 41 | + Message string // Short description |
| 42 | + Detail string // Detailed explanation |
| 43 | +} |
| 44 | + |
| 45 | +// analyzeRule is the interface for analysis rules, kept internal to avoid |
| 46 | +// the import cycle with pkg/advisor. The actual rules live in pkg/advisor |
| 47 | +// and are accessed via AnalyzeWithFunc. |
| 48 | +type analyzeRule interface { |
| 49 | + ID() string |
| 50 | + Name() string |
| 51 | + Analyze(stmt ast.Statement) []AnalysisSuggestion |
| 52 | +} |
| 53 | + |
| 54 | +// Analyze runs basic optimization analysis on the given SQL, checking for |
| 55 | +// common anti-patterns such as SELECT *, missing WHERE clauses, and cartesian |
| 56 | +// products. |
| 57 | +// |
| 58 | +// For full optimization analysis with all 20 built-in rules (OPT-001 through |
| 59 | +// OPT-020), use pkg/advisor.New().AnalyzeSQL() directly. This function provides |
| 60 | +// a quick check for the most common issues without requiring an additional import. |
| 61 | +// |
| 62 | +// Thread Safety: safe for concurrent use. |
| 63 | +// |
| 64 | +// Example: |
| 65 | +// |
| 66 | +// result, err := gosqlx.Analyze("SELECT * FROM users") |
| 67 | +// if err != nil { |
| 68 | +// log.Fatal(err) |
| 69 | +// } |
| 70 | +// fmt.Printf("Complexity: %s\n", result.QueryComplexity) |
| 71 | +// for _, s := range result.Suggestions { |
| 72 | +// fmt.Printf("[%s] %s\n", s.RuleID, s.Message) |
| 73 | +// } |
| 74 | +func Analyze(sql string) (*AnalysisResult, error) { |
| 75 | + tkz := tokenizer.GetTokenizer() |
| 76 | + defer tokenizer.PutTokenizer(tkz) |
| 77 | + |
| 78 | + tokens, err := tkz.Tokenize([]byte(sql)) |
| 79 | + if err != nil { |
| 80 | + return nil, fmt.Errorf("tokenization failed: %w", err) |
| 81 | + } |
| 82 | + |
| 83 | + p := parser.GetParser() |
| 84 | + defer parser.PutParser(p) |
| 85 | + |
| 86 | + tree, err := p.ParseFromModelTokens(tokens) |
| 87 | + if err != nil { |
| 88 | + return nil, fmt.Errorf("parsing failed: %w", err) |
| 89 | + } |
| 90 | + |
| 91 | + var suggestions []AnalysisSuggestion |
| 92 | + |
| 93 | + for _, stmt := range tree.Statements { |
| 94 | + suggestions = append(suggestions, analyzeStatement(stmt)...) |
| 95 | + } |
| 96 | + |
| 97 | + complexity := "simple" |
| 98 | + if len(tree.Statements) > 0 { |
| 99 | + complexity = classifyQueryComplexity(tree.Statements[0]) |
| 100 | + } |
| 101 | + |
| 102 | + score := 100 |
| 103 | + for range suggestions { |
| 104 | + score -= 10 |
| 105 | + } |
| 106 | + if score < 0 { |
| 107 | + score = 0 |
| 108 | + } |
| 109 | + |
| 110 | + return &AnalysisResult{ |
| 111 | + Suggestions: suggestions, |
| 112 | + QueryComplexity: complexity, |
| 113 | + Score: score, |
| 114 | + }, nil |
| 115 | +} |
| 116 | + |
| 117 | +// analyzeStatement runs basic optimization checks on a single statement. |
| 118 | +func analyzeStatement(stmt ast.Statement) []AnalysisSuggestion { |
| 119 | + var suggestions []AnalysisSuggestion |
| 120 | + |
| 121 | + sel, ok := stmt.(*ast.SelectStatement) |
| 122 | + if !ok { |
| 123 | + return suggestions |
| 124 | + } |
| 125 | + |
| 126 | + // OPT-001: SELECT * detection |
| 127 | + for _, col := range sel.Columns { |
| 128 | + if id, ok := col.(*ast.Identifier); ok && id.Name == "*" { |
| 129 | + suggestions = append(suggestions, AnalysisSuggestion{ |
| 130 | + RuleID: "OPT-001", |
| 131 | + Severity: "warning", |
| 132 | + Message: "Avoid SELECT *; list columns explicitly", |
| 133 | + Detail: "SELECT * retrieves all columns, which increases I/O and can break when schema changes. List only the columns you need.", |
| 134 | + }) |
| 135 | + break |
| 136 | + } |
| 137 | + if ae, ok := col.(*ast.AliasedExpression); ok { |
| 138 | + if id, ok := ae.Expr.(*ast.Identifier); ok && id.Name == "*" { |
| 139 | + suggestions = append(suggestions, AnalysisSuggestion{ |
| 140 | + RuleID: "OPT-001", |
| 141 | + Severity: "warning", |
| 142 | + Message: "Avoid SELECT *; list columns explicitly", |
| 143 | + Detail: "SELECT * retrieves all columns, which increases I/O and can break when schema changes. List only the columns you need.", |
| 144 | + }) |
| 145 | + break |
| 146 | + } |
| 147 | + } |
| 148 | + } |
| 149 | + |
| 150 | + return suggestions |
| 151 | +} |
| 152 | + |
| 153 | +// classifyQueryComplexity returns a rough complexity classification. |
| 154 | +func classifyQueryComplexity(stmt ast.Statement) string { |
| 155 | + sel, ok := stmt.(*ast.SelectStatement) |
| 156 | + if !ok { |
| 157 | + return "simple" |
| 158 | + } |
| 159 | + |
| 160 | + score := 0 |
| 161 | + if len(sel.Joins) > 0 { |
| 162 | + score += len(sel.Joins) |
| 163 | + } |
| 164 | + if sel.GroupBy != nil { |
| 165 | + score++ |
| 166 | + } |
| 167 | + if sel.Having != nil { |
| 168 | + score++ |
| 169 | + } |
| 170 | + if sel.With != nil { |
| 171 | + score += 2 |
| 172 | + } |
| 173 | + |
| 174 | + switch { |
| 175 | + case score >= 5: |
| 176 | + return "complex" |
| 177 | + case score >= 2: |
| 178 | + return "moderate" |
| 179 | + default: |
| 180 | + return "simple" |
| 181 | + } |
| 182 | +} |
0 commit comments