dbdocs

SaaS

Web-based database documentation generated from DBML code and published with a command-line tool, with password-protected sharing.

Competes with

dbdocs.io
dbdocs homepage screenshot

About dbdocs

dbdocs builds web-based database documentation from code. You describe a schema in DBML, an open-source markup language for defining database structure, keep the file locally or check it into Git, and publish it to a project with the dbdocs command-line tool installed through npm.

The generated site shows tables and fields with detailed table metadata, plus visual relationships between tables. A project can be protected with a password and shared through secure URLs with new developers or external clients, so the same pages work for internal teams and outside readers.

Because the schema is a plain file, it can live in Git and plug into CI/CD. dbdocs belongs to a group of related tools on the same site: dbdiagram for ER diagrams, RunSQL for testing queries, the dbml language itself and Holistics.io for BI reporting. The site describes dbdocs as free.

Key features

  • Schema defined as DBML code
  • Command-line install and push to a project
  • Table metadata and visual relationships
  • Password protection for documentation
  • Secure URLs for sharing with developers and clients
  • Git and CI/CD integration

Good fit for

  • Living schema documentation
  • Sharing a schema with external clients
  • Onboarding new developers
Tags
database
documentation
dbml
schema
erd
cli
developer-tools

dbdocs: questions and answers

What is dbdocs used for?
dbdocs is web-based database documentation generated from DBML code and published with a command-line tool, with password-protected sharing. It is a good fit for living schema documentation, sharing a schema with external clients and onboarding new developers.
Is dbdocs open source?
No. dbdocs is proprietary (closed-source) software. In the Docs & Wikis category, open-source options include Schemacrawler, DevDocs and Zeal.
What are some alternatives to dbdocs?
dbdocs competes with dbdiagram.io.

Open-source alternatives to dbdocs

See all

SaaS alternatives to dbdocs

See all