built by

Document and Catalog Your Databases Easily

A free, simple tool to create web-based documentation for your database.
Designed for developers. Integrate seamlessly with your development workflow.

💪 Access Open Beta

Define your database using simple, standardized language

Define your database schema using DBML, a simple and open-source standard.

Project social_blogging_site {
database_type: 'PostgreSQL'
Note: 'Social Blogging Site Database'
}

Table users {
id integer
username varchar
role varchar
created_at timestamp
}

Table posts {
id integer [primary key]
title varchar
body text [note: 'Content of the post']
user_id integer
status post_status
created_at timestamp
}

Enum post_status {
draft
published
private [note: 'visible via URL only']
}

Ref: posts.user_id > users.id // many-to-one

Generate web document of database with simple command lines

Install our dbdocs command line. Create projects and push with a few commands.

## Download dbdocs command line
$ npm install -g dbdocs
dbdocs install...


## Generate dbdocs view
$ dbdocs build database.dbml --project=your_project
Pushing new database schema to project your_project...
Done. Visit: https://dbdocs.io/username/your_project

Done. Beautiful database document created.

Browse through tables and fields, visualize tables' relationships. Share with internal development team.

dbdocs - Docs Image dbdocs - Diagram Image

Keep your document private

Generate passwords quickly for your clients or internal use.

$ dbdocs password --set yourpassword1234 --project dbdiagram
Password is set for 'dbdiagram'
dbdocs - Protected View

Why dbdocs.io?

dbdocs - Create DB Icon

Create database document instantly

Get a web database documentation up and running in just minutes. Share with your colleagues to view and collaborate.
dbdocs - DB As Code Icon

Database As Code

Your entire database is now documented as code (using DBML). No more baffling with extraneous SQL DDL, or weird framework's database definition.
dbdocs - Integrated Icon

Designed for modern development workflow

dbdocs is designed to integrate with your development workflow.

Easily set up automated push from your app's database code change to dbdocs.

FAQs⁉️

What markup language is the dbdocs following?

We use DBML - Database Markup Language, a markup language designed to easily document database structures.

DBML is also completely open-source on Github.

Is my dbdocs project public? How can I make it private?

Your dbdocs project is set to be public by default. However, you can follow our instructions here to protect it with a password or remove the project after testing.

Who created dbdocs?

We are Holistics, an analytics platform for tech companies (you should check us out).
We also created dbdiagram and DBML, the predecessor to current dbdocs.

How can I integrate this with my development workflow?

Step 1- create a database.dbml in your root folder of your Git repo. Type up your database definition there.

Step 2- Design a simple hook to push database.dbml to your dbdocs project (run $ dbdocs build database.dbml) everytime a commit is made.

Step 3- Make sure when you make database migration, update database.dbml with the relevant change.

How can I delete a project?

Simply run $ dbdocs remove <project_name>

Access the open beta today and start documenting your database!

💪 Access Open Beta