Freedom251 › Database Documentation Tools
DbSketch

What DbSketch is
DbSketch is a command-line tool that turns a live relational database schema into documentation that can be kept under version control. It reads tables, columns, primary keys, and foreign keys from SQL Server, PostgreSQL, MySQL, and SQLite, then produces Graphviz DOT, Mermaid ER, or Markdown files containing diagram text. A YAML configuration specifies one database connection and can name multiple diagram targets, each with its own output and renderer settings. DbSketch can include native database comments where supported, with YAML overrides available, and its DOT output connects foreign keys to their specific columns. The maker identifies repository documentation, CI workflows, and compact schema context for people and AI coding assistants as uses for the tool. It is distributed as the .NET tool DimonSmart.DbSketch, which installs the `dbsketch` command; the getting-started guide requires the .NET 10 SDK. It is free, MIT-licensed, self-hosted, and available for Linux, macOS, and Windows.
Who it suits
DbSketch suits developers who want reviewable schema diagrams in a repository or CI workflow, and people preparing compact schema context for AI coding assistants. It supports relational databases on Linux, macOS, and Windows.
What it does well
- Reads four relational database types.
- Produces DOT, Mermaid ER, or Markdown output.
- One configuration can define multiple diagram targets.
- Can include native comments and YAML overrides.
- Free and MIT-licensed.
What to know first
- Requires the .NET 10 SDK.
- Self-hosted; no managed deployment is listed.
Plans
| Plan | Billed and limits | Price |
|---|---|---|
| DbSketch | MIT-licensed software | Free |
As github.com lists them, read 4 Oct 2026. The maker's own page has the final word.
Getting started
- Install the .NET 10 SDK.
- Install the .NET tool DimonSmart.DbSketch to get the `dbsketch` command.
- Create a YAML configuration with one database connection.
- Add any named diagram targets and their output and renderer settings.
- Run DbSketch against the configured database to generate documentation.
Verdict
DbSketch covers schema documentation from four database types, with several output formats and per-diagram settings. Its command-line approach and .NET 10 requirement are important to account for before adopting it.
Questions
Is DbSketch free?
Yes. The listed plan is free, and the software is MIT-licensed.
Which databases does it support?
It reads schema details from SQL Server, PostgreSQL, MySQL, and SQLite.
What formats can it generate?
It generates Graphviz DOT, Mermaid ER, or Markdown files with diagram text in a fenced code block.
Which operating systems can run DbSketch?
It is listed for Linux, macOS, and Windows.
How is DbSketch installed?
It is distributed as the .NET tool DimonSmart.DbSketch, which installs the `dbsketch` command. The getting-started guide requires the .NET 10 SDK.
Who makes DbSketch?
The repository is maintained by DimonSmart and welcomes issues and pull requests, including provider, renderer, and documentation improvements.
Facts from DbSketch's own pages
- Comments
- It can include native database comments where supported and apply YAML comment overrides. · github.com, 4 Oct 2026
- Configuration
- DbSketch uses a YAML configuration file with one database connection and optional named diagram targets. · github.com, 4 Oct 2026
- Database providers
- It reads tables, columns, primary keys, and foreign keys from SQL Server, PostgreSQL, MySQL, and SQLite. · github.com, 4 Oct 2026
- Distribution
- DbSketch is distributed as the .NET tool DimonSmart.DbSketch, which installs the dbsketch command. · github.com, 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, 4 Oct 2026
- License
- The repository provides DbSketch under the MIT License. · github.com, 4 Oct 2026
- Multiple diagrams
- One configuration can generate multiple focused diagrams with per-diagram output and renderer settings. · github.com, 4 Oct 2026
- Output formats
- It generates Graphviz DOT, Mermaid ER, or Markdown files wrapping diagram text in a fenced code block. · github.com, 4 Oct 2026
- Purpose
- DbSketch is a command-line documentation generator that turns live database schemas into version-controlled schema documentation. · github.com, 4 Oct 2026
- Relationships
- The DOT renderer preserves precise column-to-column foreign-key edges. · github.com, 4 Oct 2026
- Requirement
- The getting-started guide says to install the .NET 10 SDK before installing or running DbSketch. · github.com, 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, 4 Oct 2026
- Support
- The maker welcomes issues and pull requests, including provider, renderer, and documentation improvements. · github.com, 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, 4 Oct 2026
Where DbSketch stands on Freedom251
- Database Documentation Tools#6 of 27