Skip to content

Commit e49f41f

Browse files
Ajit Pratap Singhclaude
authored andcommitted
docs: comprehensive v1.6.0 feature documentation update
Based on parallel agent review of all documentation, this commit updates: Migration Guides: - FROM_SQLFLUFF.md: Fixed "Coming in v1.5.0" → "Available in v1.6.0" for linting - FROM_SQLFLUFF.md: Updated FAQ to reflect 10 linting rules now available - FROM_PG_QUERY.md: Fixed "planned for v1.5.0" → "planned for future release" SQL Compatibility (SQL_COMPATIBILITY.md): - LATERAL JOIN: Updated from "10% Syntax" to "95% Full support" - JSON/JSONB: Updated from "30% Syntax" to "95% Full support" with all operators - Added DISTINCT ON: 95% Full support - Added FILTER clause: 95% Full support - Added RETURNING clause: 95% Full support Comparison Guide (COMPARISON.md): - Updated linting from "❌ Planned" to "✅ 10 rules (L001-L010)" - Updated limitations section to reflect 10 rules available Documentation Index (docs/README.md): - Updated all document versions from v1.5.1 to v1.6.0 - Updated dates from 2025-11 to 2025-12 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]>
1 parent 4d8a145 commit e49f41f

File tree

5 files changed

+25
-22
lines changed

5 files changed

+25
-22
lines changed

docs/COMPARISON.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This guide helps you choose the right SQL parsing tool for your needs. We provid
1919
| **Zero Dependencies** | ✅ Yes | ❌ No | ❌ No | ✅ Yes | ⚠️ Minimal |
2020
| **SQL Validation** | ✅ Fast | ✅ Rules-based | ❌ No | ✅ Yes | ✅ Yes |
2121
| **SQL Formatting** | ✅ Fast | ✅ Full | ✅ Opinionated | ⚠️ Basic | ❌ No |
22-
| **Linting Rules** | ❌ Planned | ✅ 60+ rules | ❌ No | ❌ No | ❌ No |
22+
| **Linting Rules** | ✅ 10 rules (L001-L010) | ✅ 60+ rules | ❌ No | ❌ No | ❌ No |
2323
| **Multi-Dialect** | ✅ 5 dialects | ✅ 60+ dialects | ⚠️ Limited | ⚠️ 4 dialects | ❌ PostgreSQL only |
2424
| **CLI Tool** | ✅ Fast | ✅ Feature-rich | ✅ Simple | ❌ No | ⚠️ Limited |
2525
| **Library API** | ✅ Simple | ✅ Complex | ⚠️ Limited | ✅ Full | ✅ Full |
@@ -190,8 +190,8 @@ SQLFluff: ~50 KB (25x)
190190

191191
**Don't Choose GoSQLX if:**
192192

193-
**You need linting rules**
194-
- SQLFluff has 60+ rules, GoSQLX has 0 (planned)
193+
⚠️ **You need comprehensive linting (60+ rules)**
194+
- SQLFluff has 60+ rules, GoSQLX has 10 rules (L001-L010) in v1.6.0
195195

196196
**You need 60+ SQL dialects**
197197
- GoSQLX supports 5 dialects

docs/README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -198,17 +198,17 @@ If you can't find what you need:
198198

199199
| Document | Last Updated | Version |
200200
|----------|--------------|---------|
201-
| API_REFERENCE.md | 2025-11 | v1.5.1 |
202-
| GETTING_STARTED.md | 2025-11 | v1.5.1 |
203-
| CLI_GUIDE.md | 2025-11 | v1.5.1 |
204-
| USAGE_GUIDE.md | 2025-11 | v1.5.1 |
205-
| ARCHITECTURE.md | 2025-11 | v1.5.1 |
206-
| TROUBLESHOOTING.md | 2025-11 | v1.5.1 |
207-
| PRODUCTION_GUIDE.md | 2025-11 | v1.5.1 |
208-
| SQL_COMPATIBILITY.md | 2025-11 | v1.5.1 |
209-
| SECURITY.md | 2025-11 | v1.5.1 |
210-
| ERROR_CODES.md | 2025-11 | v1.5.1 |
211-
| PERFORMANCE_TUNING.md | 2025-11 | v1.5.1 |
201+
| API_REFERENCE.md | 2025-12 | v1.6.0 |
202+
| GETTING_STARTED.md | 2025-12 | v1.6.0 |
203+
| CLI_GUIDE.md | 2025-12 | v1.6.0 |
204+
| USAGE_GUIDE.md | 2025-12 | v1.6.0 |
205+
| ARCHITECTURE.md | 2025-12 | v1.6.0 |
206+
| TROUBLESHOOTING.md | 2025-12 | v1.6.0 |
207+
| PRODUCTION_GUIDE.md | 2025-12 | v1.6.0 |
208+
| SQL_COMPATIBILITY.md | 2025-12 | v1.6.0 |
209+
| SECURITY.md | 2025-12 | v1.6.0 |
210+
| ERROR_CODES.md | 2025-12 | v1.6.0 |
211+
| PERFORMANCE_TUNING.md | 2025-12 | v1.6.0 |
212212

213213
## Recent Feature Additions (v1.4+)
214214

docs/SQL_COMPATIBILITY.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ This matrix documents the comprehensive SQL feature support in GoSQLX across dif
8888
| **NATURAL JOIN** |||||| ✅ Full | 95% |
8989
| Multiple table JOINs |||||| ✅ Full | 100% |
9090
| Self JOINs |||||| ✅ Full | 100% |
91-
| **LATERAL JOIN** |||||| 🔧 Syntax | 10% |
91+
| **LATERAL JOIN** |||||| ✅ Full | 95% |
9292

9393
### Subqueries
9494

@@ -191,9 +191,12 @@ This matrix documents the comprehensive SQL feature support in GoSQLX across dif
191191
| Feature | Support Level | GoSQLX Parser | Test Coverage | Notes |
192192
|---------|---------------|---------------|---------------|-------|
193193
| **Arrays** | ✅ Full | 🔧 Syntax | 40% | Keyword recognition only |
194-
| **JSON/JSONB** | ✅ Full | 🔧 Syntax | 30% | Data type recognition |
194+
| **JSON/JSONB** | ✅ Full | ✅ Full | 95% | Full operator support (`->`, `->>`, `#>`, `#>>`, `@>`, `<@`, `?`, `?|`, `?&`, `#-`) |
195+
| **DISTINCT ON** | ✅ Full | ✅ Full | 95% | PostgreSQL-specific SELECT DISTINCT ON (columns) |
196+
| **FILTER clause** | ✅ Full | ✅ Full | 95% | Aggregate FILTER (WHERE condition) support |
197+
| **RETURNING clause** | ✅ Full | ✅ Full | 95% | INSERT/UPDATE/DELETE RETURNING support |
195198
| **Full-text search** | ✅ Full | 🔧 Syntax | 30% | tsvector, tsquery types |
196-
| **LATERAL joins** | ✅ Full | 🔧 Syntax | 20% | Keyword reserved, no parsing logic |
199+
| **LATERAL joins** | ✅ Full | ✅ Full | 95% | Full support with LEFT/INNER/CROSS variants |
197200
| **Custom operators** | ✅ Full | ⚠️ Partial | 30% | Basic operator recognition |
198201
| **Dollar quoting** | ✅ Full | ⚠️ Partial | 40% | Limited support |
199202

docs/migration/FROM_PG_QUERY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ func normalizeQuery(sql string) string {
290290
return result
291291
}
292292

293-
// Note: Built-in normalization planned for GoSQLX v1.5.0
293+
// Note: Built-in normalization is planned for a future release
294294
```
295295

296296
### Example 3: Multi-Dialect Support
@@ -684,7 +684,7 @@ func main() {
684684
cache.IsDuplicate("SELECT * FROM users WHERE id = 2") // true (duplicate pattern)
685685
}
686686

687-
// Note: Built-in fingerprinting planned for GoSQLX v1.5.0
687+
// Note: Built-in fingerprinting is planned for a future release
688688
```
689689

690690
### Pattern 2: Database Migration Tool
@@ -1143,7 +1143,7 @@ For heavy PL/pgSQL use, keep pg_query or contribute PL/pgSQL support to GoSQLX.
11431143
**A:** You'll go from 100% to ~80-85% coverage. For most applications, this is sufficient. Test your queries!
11441144

11451145
### Q: What about normalization/fingerprinting?
1146-
**A:** Implement manually (examples provided) or wait for v1.5.0 with built-in support.
1146+
**A:** Implement manually using the examples provided above. Built-in support is planned for a future release.
11471147

11481148
### Q: Can I support multiple databases?
11491149
**A:** Yes! That's GoSQLX's main advantage. Support PostgreSQL + MySQL + SQL Server + Oracle + SQLite.

docs/migration/FROM_SQLFLUFF.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -820,7 +820,7 @@ Status: SUCCESS
820820

821821
### Features Not Available in GoSQLX
822822

823-
#### 1. Linting Rules (Coming in v1.5.0)
823+
#### 1. Linting Rules (Available in v1.6.0)
824824
**SQLFluff Has:**
825825
- 60+ built-in rules (L001-L064)
826826
- Custom rule creation
@@ -927,7 +927,7 @@ Use SQLFluff for unsupported dialects, or contribute dialect support to GoSQLX!
927927
## FAQ
928928

929929
### Q: Can I use both SQLFluff and GoSQLX together?
930-
**A:** Yes! Use GoSQLX for fast parsing/validation and SQLFluff for linting until GoSQLX adds linting rules in v1.5.0.
930+
**A:** Yes! GoSQLX now has 10 linting rules (L001-L010) with auto-fix in v1.6.0. Use GoSQLX for fast parsing/validation/linting, and SQLFluff for comprehensive 60+ rule coverage.
931931

932932
### Q: Will GoSQLX replace SQLFluff completely?
933933
**A:** Not yet. SQLFluff has more features (linting, templates, dialects). But for parsing/validation, GoSQLX is 1000x faster!

0 commit comments

Comments
 (0)