61 lines
3.3 KiB
Markdown
61 lines
3.3 KiB
Markdown
# Documentation Index
|
|
|
|
This folder contains comprehensive documentation for the Strata.SqlTools library.
|
|
|
|
## Architecture & Design
|
|
|
|
- **[ARCHITECTURE_REVIEW.md](ARCHITECTURE_REVIEW.md)** - Complete architecture overview with class diagrams, design patterns, and extensibility guidelines
|
|
- **[Rules.ClassDiagram.md](Rules.ClassDiagram.md)** - Class diagrams for the expression/rules system with Markdown parser documentation
|
|
|
|
## Component Documentation
|
|
|
|
- **[SqlUtilities.Core.md](SqlUtilities.Core.md)** - Core library documentation with API reference and usage examples (1400+ lines)
|
|
- **[SqlUtilities.SqlServer.md](SqlUtilities.SqlServer.md)** - SQL Server (T-SQL) specific implementations
|
|
- **[SqlUtilities.PostgreSql.md](SqlUtilities.PostgreSql.md)** - PostgreSQL specific implementations with parameter support
|
|
- **[SqlUtilities.Snowflake.md](SqlUtilities.Snowflake.md)** - Snowflake SQL specific implementations
|
|
- **[SqlUtilities.LinqToSql.md](SqlUtilities.LinqToSql.md)** - LINQ to SQL query analysis and visualization
|
|
- **[SqlUtilities.Markdown.md](SqlUtilities.Markdown.md)** - Query visualization with Mermaid diagrams
|
|
|
|
## Development Guides
|
|
|
|
- **[EFCore_Integration_Guide.md](EFCore_Integration_Guide.md)** - Entity Framework Core integration patterns and usage
|
|
- **[EFCore_Project_Summary.md](EFCore_Project_Summary.md)** - EFCore project overview and features
|
|
- **[NUGET_PACKAGING.md](NUGET_PACKAGING.md)** - NuGet package best practices, build configuration, and publishing checklist
|
|
- **[WITHCLAUSE_NEXT_STEPS.md](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](SqlBreakdownCollection_Usage.md)** - Working with query collections and batch analysis
|
|
|
|
## Quick Start
|
|
|
|
For a quick start guide, see the main [README.md](../README.md) in the repository root.
|
|
|
|
## Navigation
|
|
|
|
### By Topic
|
|
|
|
**Getting Started:**
|
|
- [SqlUtilities.SqlServer.md](SqlUtilities.SqlServer.md) - SQL Server/T-SQL
|
|
- [SqlUtilities.PostgreSql.md](SqlUtilities.PostgreSql.md) - PostgreSQL
|
|
- [SqlUtilities.Snowflake.md](SqlUtilities.Snowflake.md) - Snowflake
|
|
- [SqlUtilities.LinqToSql.md](SqlUtilities.LinqToSql.md) - LINQ query analysis
|
|
1. Read [../README.md](../README.md) for overview and basic usage
|
|
2. Review [SqlUtilities.Core.md](SqlUtilities.Core.md) for detailed API documentation
|
|
3. Choose your SQL dialect: [SqlUtilities.SqlServer.md](SqlUtilities.SqlServer.md) or [SqlUtilities.Snowflake.md](SqlUtilities.Snowflake.md)
|
|
|
|
**Understanding the Architecture:**
|
|
1. Start with [ARCHITECTURE_REVIEW.md](ARCHITECTURE_REVIEW.md) for design patterns and class structure
|
|
2. Review [Rules.ClassDiagram.md](Rules.ClassDiagram.md) for expression system details
|
|
|
|
**Publishing & Packaging:**
|
|
1. Read [NUGET_PACKAGING.md](NUGET_PACKAGING.md) for build and publishing guidelines
|
|
|
|
**Advanced Features:**
|
|
1. See [WITHCLAUSE_NEXT_STEPS.md](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
|