- Home
- Database Documentation Tools
- DbSketch
DbSketch
What it is
DbSketch is a free command-line documentation generator that turns live relational database schemas into version-controlled documentation. It reads tables, columns, primary keys, and foreign keys from SQL Server, PostgreSQL, MySQL, and SQLite. Output can be Graphviz DOT, Mermaid ER, or Markdown containing diagram text in a fenced code block. A YAML configuration holds one database connection and can define named diagram targets, allowing several focused diagrams with separate output and renderer settings. DbSketch can include native database comments where supported and apply YAML comment overrides. Its DOT renderer preserves foreign-key relationships down to individual columns. The maker describes uses in repository documentation, CI, and compact schema snapshots for people and AI coding assistants. Distributed as the .NET tool DimonSmart.DbSketch, it installs the dbsketch command; the guide requires the .NET 10 SDK. It is MIT-licensed and self-hosted.
For and against
For
- Free MIT-licensed software
- Supports four relational databases
- Graphviz, Mermaid, and Markdown output
- Multiple focused diagrams from YAML
- Precise column-level foreign-key edges
Against
- Requires the .NET 10 SDK
- Command-line and self-hosted only
- No data lineage feature
The verdict
DbSketch provides a focused, scriptable route from live schemas to version-controlled diagrams and documentation. Its database coverage and .NET requirement should match your environment.
Who it suits
DbSketch suits developers and AI coding assistants that need compact, reviewable schema documentation. It fits repository and CI workflows on Linux, macOS, or Windows.
Plans and prices
DbSketch
MIT-licensed software
Read 4 Oct 2026 · github.com
On the record
- Comments
- It can include native database comments where supported and apply YAML comment overrides.github.com · read 4 Oct 2026
- Configuration
- DbSketch uses a YAML configuration file with one database connection and optional named diagram targets.github.com · read 4 Oct 2026
- Database providers
- It reads tables, columns, primary keys, and foreign keys from SQL Server, PostgreSQL, MySQL, and SQLite.github.com · read 4 Oct 2026
- Distribution
- DbSketch is distributed as the .NET tool DimonSmart.DbSketch, which installs the dbsketch command.github.com · read 4 Oct 2026
- Intended users
- The maker says DbSketch is for humans and AI coding assistants that need a compact, reviewable schema snapshot.github.com · read 4 Oct 2026
- License
- The repository provides DbSketch under the MIT License.github.com · read 4 Oct 2026
- Multiple diagrams
- One configuration can generate multiple focused diagrams with per-diagram output and renderer settings.github.com · read 4 Oct 2026
- Output formats
- It generates Graphviz DOT, Mermaid ER, or Markdown files wrapping diagram text in a fenced code block.github.com · read 4 Oct 2026
- Purpose
- DbSketch is a command-line documentation generator that turns live database schemas into version-controlled schema documentation.github.com · read 4 Oct 2026
- Relationships
- The DOT renderer preserves precise column-to-column foreign-key edges.github.com · read 4 Oct 2026
- Requirement
- The getting-started guide says to install the .NET 10 SDK before installing or running DbSketch.github.com · read 4 Oct 2026
- Security and data handling
- The documentation shows database connection strings supplied through configuration or environment-variable placeholders; it does not state a security certification or compliance claim.github.com · read 4 Oct 2026
- Support
- The maker welcomes issues and pull requests, including provider, renderer, and documentation improvements.github.com · read 4 Oct 2026
- Use cases
- The maker describes DbSketch as useful for repository documentation, CI, and compact schema context for AI coding assistants.github.com · read 4 Oct 2026
