Add full Markdown documentation set

This commit is contained in:
root
2026-02-26 07:49:08 +01:00
parent faf45eed1e
commit 984870f510
10 changed files with 618 additions and 0 deletions

37
docs/README.md Normal file
View File

@@ -0,0 +1,37 @@
# DynamORM Documentation
This documentation is based on:
- XML comments in the library source (`DynamORM/*.cs`, `DynamORM/*/*.cs`).
- Executable usage patterns from the test suite (`DynamORM.Tests`).
## Contents
- [Quick Start](quick-start.md)
- [Dynamic Table API](dynamic-table-api.md)
- [Fluent Builder API](fluent-builder-api.md)
- [Mapping and Entities](mapping-and-entities.md)
- [Transactions and Disposal](transactions-and-disposal.md)
- [Stored Procedures](stored-procedures.md)
- [.NET 4.0 Amalgamation](net40-amalgamation.md)
- [Test-Driven Examples](test-driven-examples.md)
## Supported Targets
Main library targets are defined in `DynamORM/DynamORM.csproj`.
For legacy .NET 4.0 consumers, use the amalgamated source workflow documented in [.NET 4.0 Amalgamation](net40-amalgamation.md).
## Design Overview
DynamORM provides two major usage styles:
- Dynamic table access:
- `db.Table("users").Count(...)`
- `db.Table("users").Insert(...)`
- `db.Table("users").Query(...)`
- Fluent SQL builder access:
- `db.From<T>()`
- `db.Select<T>()`
- `db.Insert<T>() / db.Update<T>() / db.Delete<T>()`
The dynamic API is concise and fast to use. The fluent builder API gives stronger composition and explicit SQL control.