🧠 Second Brain

DBML

Last updated Aug 5, 2024

DBML (Database Markup Language) is an open-source DSL language designed to define and document database schemas and structures. It is designed to be simple, consistent, and highly readable.

It also comes with a command-line tool and open-source module to help you convert between DBML and SQL.

# Benefits

It is simple, flexible, and highly human-readable
It is database agnostic, focusing on the essential database structure definition without worrying about the detailed syntaxes of each database
Comes with a free, simple database visualizer at dbdiagram.io
Also comes with a free database documentation app at dbdocs.io

# Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


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
    created_at timestamp
}

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