Thom LambandClaude Opus 4.7
6b461095c6
Design doc covering the 8 BLOCKER/CRITICAL non-S3776 issues across six projects. Approach is a pragmatic mix: fix where the rule reflects a real defect, suppress with justification where the rule conflicts with deliberate design (DSL operator==). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Documentation Index
This folder contains comprehensive documentation for the Strata.SqlTools library.
Architecture & Design
- ARCHITECTURE_REVIEW.md - Complete architecture overview with class diagrams, design patterns, and extensibility guidelines
- Rules.ClassDiagram.md - Class diagrams for the expression/rules system with Markdown parser documentation
Component Documentation
- SqlUtilities.Core.md - Core library documentation with API reference and usage examples (1400+ lines)
- SqlUtilities.SqlServer.md - SQL Server (T-SQL) specific implementations
- SqlUtilities.PostgreSql.md - PostgreSQL specific implementations with parameter support
- SqlUtilities.Snowflake.md - Snowflake SQL specific implementations
- SqlUtilities.LinqToSql.md - LINQ to SQL query analysis and visualization
- SqlUtilities.Markdown.md - Query visualization with Mermaid diagrams
Development Guides
- EFCore_Integration_Guide.md - Entity Framework Core integration patterns and usage
- EFCore_Project_Summary.md - EFCore project overview and features
- NUGET_PACKAGING.md - NuGet package best practices, build configuration, and publishing checklist
- WITHCLAUSE_NEXT_STEPS.md - Complete WITH clause (CTE) implementation status, feature coverage (98+ tests), and recommendations for Performance Optimization (P4) and Developer Experience (P5) improvements
- SqlBreakdownCollection_Usage.md - Working with query collections and batch analysis
Quick Start
For a quick start guide, see the main README.md in the repository root.
Navigation
By Topic
Getting Started:
- SqlUtilities.SqlServer.md - SQL Server/T-SQL
- SqlUtilities.PostgreSql.md - PostgreSQL
- SqlUtilities.Snowflake.md - Snowflake
- SqlUtilities.LinqToSql.md - LINQ query analysis
- Read ../README.md for overview and basic usage
- Review SqlUtilities.Core.md for detailed API documentation
- Choose your SQL dialect: SqlUtilities.SqlServer.md or SqlUtilities.Snowflake.md
Understanding the Architecture:
- Start with ARCHITECTURE_REVIEW.md for design patterns and class structure
- Review Rules.ClassDiagram.md for expression system details
Publishing & Packaging:
- Read NUGET_PACKAGING.md for build and publishing guidelines
Advanced Features:
- See WITHCLAUSE_NEXT_STEPS.md for WITH clause implementation details
Documentation Standards
All documentation in this folder follows these standards:
- Markdown format with Mermaid diagrams where applicable
- Code examples in C#
- Updated date stamps where relevant
- Links to official Microsoft documentation where appropriate