Skip to content

Commit d4d5746

Browse files
ajitpratap0Ajit Pratap Singhclaude
authored
docs: update documentation to reflect v1.6.0 features as available (#185)
* docs: update documentation to reflect v1.6.0 features as available This commit updates all documentation to reflect that v1.6.0 features are now available (not planned): Migration Guides: - FROM_SQLFLUFF.md: Updated linting rules (10 rules L001-L010), auto-fix, VSCode extension, and .gosqlx.yml config as available in v1.6.0 - FROM_PG_QUERY.md: Updated JSON/JSONB operators as supported in v1.6.0 Documentation Updates: - Updated version references from v1.5.x to v1.6.0 across all docs - Added v1.6.0 upgrade section to UPGRADE_GUIDE.md - Updated COMPARISON.md with v1.6.0 features and performance data - Updated CLAUDE.md production status to v1.6.0+ - Updated performance_baselines.json to v1.6.0 Key v1.6.0 Features Now Documented: - PostgreSQL Extensions (LATERAL JOIN, JSON/JSONB operators, DISTINCT ON) - Language Server Protocol (LSP) server - VSCode Extension - 10 Linting Rules (L001-L010) with auto-fix - .gosqlx.yml configuration file support - go-task Taskfile.yml - Structured error codes (E1001-E3004) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * 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 <noreply@anthropic.com> * docs: add dedicated LSP, linting, and configuration guides with PostgreSQL examples New Documentation: - docs/LSP_GUIDE.md: Complete Language Server Protocol guide covering IDE integration, features, error codes, and troubleshooting - docs/LINTING_RULES.md: Full reference for all 10 linting rules (L001-L010) with examples, severity levels, and auto-fix capabilities - docs/CONFIGURATION.md: Comprehensive configuration guide for .gosqlx.yml with schema documentation, defaults, and best practices New PostgreSQL Feature Examples: - examples/postgresql/lateral-join/: LATERAL JOIN parsing demonstrations - examples/postgresql/jsonb-operators/: JSON/JSONB operator support (->/->>/#>/#>>/@>/<@/?/?|/?&/#-) - examples/postgresql/filter-clause/: FILTER clause for conditional aggregation - examples/postgresql/returning-clause/: RETURNING clause for DML statements Updated: - examples/README.md: Added new examples to documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Ajit Pratap Singh <ajitpratapsingh@Ajits-Mac-mini.local> Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 563ea8b commit d4d5746

File tree

23 files changed

+2736
-66
lines changed

23 files changed

+2736
-66
lines changed

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66

77
GoSQLX is a **production-ready**, **race-free**, high-performance SQL parsing SDK for Go that provides lexing, parsing, and AST generation with zero-copy optimizations. The library is designed for enterprise use with comprehensive object pooling for memory efficiency.
88

9-
### **Production Status**: ✅ **VALIDATED FOR PRODUCTION DEPLOYMENT** (v1.5.1+)
9+
### **Production Status**: ✅ **VALIDATED FOR PRODUCTION DEPLOYMENT** (v1.6.0+)
1010
- **Thread Safety**: Confirmed race-free through comprehensive concurrent testing
1111
- **Performance**: 1.38M+ operations/second sustained, up to 1.5M peak with memory-efficient object pooling
1212
- **International**: Full Unicode support for global SQL processing
@@ -471,7 +471,7 @@ These mistakes have been made before - avoid them:
471471
- ✅ Allows for comprehensive testing and validation before tagging
472472
- ✅ Enables rollback if critical issues are found before release
473473

474-
## Current SQL Feature Support (v1.5.1+)
474+
## Current SQL Feature Support (v1.6.0)
475475

476476
### GROUPING SETS, ROLLUP, CUBE (SQL-99 T431) - Complete ✅
477477
```sql

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ gosqlx analyze "SELECT COUNT(*) FROM orders GROUP BY status"
145145
# Parse SQL to AST representation
146146
gosqlx parse -f json complex_query.sql
147147

148-
# Unix Pipeline Support (NEW in v1.5.0)
148+
# Unix Pipeline Support
149149
cat query.sql | gosqlx format # Format from stdin
150150
echo "SELECT * FROM users" | gosqlx validate # Validate from pipe
151151
gosqlx format query.sql | gosqlx validate # Chain commands

docs/COMPARISON.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# GoSQLX vs Alternatives: Comprehensive Comparison
22

3-
**Last Updated:** 2025-11-28
4-
**GoSQLX Version:** v1.5.1
3+
**Last Updated:** 2025-12-11
4+
**GoSQLX Version:** v1.6.0
55

66
This guide helps you choose the right SQL parsing tool for your needs. We provide an honest assessment of GoSQLX's strengths and limitations compared to popular alternatives.
77

@@ -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
@@ -311,6 +311,6 @@ See individual migration guides for code examples and patterns.
311311
---
312312

313313
**Last Updated:** 2025-11-28
314-
**Version:** v1.5.1
314+
**Version:** v1.6.0
315315

316316
*Benchmark numbers are reproducible. See `/benchmarks` directory.*

0 commit comments

Comments
 (0)