DbSketch
github.com
What it is
DbSketch is a command-line generator for turning 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 choices are Graphviz DOT, Mermaid ER, or Markdown files with diagram text in a fenced code block. A YAML configuration holds one database connection and can define named diagram targets, allowing one setup to produce multiple 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 the connected columns. The maker describes it as useful for repository documentation, CI, and compact schema snapshots for people and AI coding assistants. It is distributed as the.NET tool DimonSmart.DbSketch, which installs the dbsketch command; the getting-started guide requires the.NET 10 SDK. The software is MIT-licensed and costs nothing. It runs on Linux, macOS, and Windows and is self-hosted.
Spec sheet
- Purpose
- DbSketch is a command-line documentation generator that turns live database schemas into version-controlled schema documentation.Read 4 Oct 2026 · github.com
- Intended users
- The maker says DbSketch is for humans and AI coding assistants that need a compact, reviewable schema snapshot.Read 4 Oct 2026 · github.com
- Support
- The maker welcomes issues and pull requests, including provider, renderer, and documentation improvements.Read 4 Oct 2026 · github.com
- License
- The repository provides DbSketch under the MIT License.Read 4 Oct 2026 · github.com
- Comments
- It can include native database comments where supported and apply YAML comment overrides.Read 4 Oct 2026 · github.com
- Configuration
- DbSketch uses a YAML configuration file with one database connection and optional named diagram targets.Read 4 Oct 2026 · github.com
- Database providers
- It reads tables, columns, primary keys, and foreign keys from SQL Server, PostgreSQL, MySQL, and SQLite.Read 4 Oct 2026 · github.com
- Distribution
- DbSketch is distributed as the .NET tool DimonSmart.DbSketch, which installs the dbsketch command.Read 4 Oct 2026 · github.com
- Multiple diagrams
- One configuration can generate multiple focused diagrams with per-diagram output and renderer settings.Read 4 Oct 2026 · github.com
- Output formats
- It generates Graphviz DOT, Mermaid ER, or Markdown files wrapping diagram text in a fenced code block.Read 4 Oct 2026 · github.com
- Relationships
- The DOT renderer preserves precise column-to-column foreign-key edges.Read 4 Oct 2026 · github.com
- Requirement
- The getting-started guide says to install the .NET 10 SDK before installing or running DbSketch.Read 4 Oct 2026 · github.com
- 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.Read 4 Oct 2026 · github.com
- Use cases
- The maker describes DbSketch as useful for repository documentation, CI, and compact schema context for AI coding assistants.Read 4 Oct 2026 · github.com
Plans and prices
Strong points and limits
Strong points
- Reads four relational database providers.
- Generates Graphviz DOT, Mermaid ER, or Markdown.
- One configuration can produce multiple focused diagrams.
- MIT-licensed and costs nothing.
- Available for Linux, macOS, and Windows.
Limits
- Requires the .NET 10 SDK.
- Database connection configuration is required.
- No data lineage support is listed.
Who it suits
DbSketch suits developers and teams who want reviewable schema documentation in repositories or CI. It may also help provide compact schema context to AI coding assistants.
Verdict
DbSketch provides several diagram and documentation formats for relational schemas, with focused outputs configurable from YAML. It requires the .NET 10 SDK and runs as a self-hosted command-line tool.
Where Specifiction places it
- Database Documentation Tools#15 of 277.9