Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/holistics/dbml

Database Markup Language (DBML), designed to define and document database structures
https://github.com/holistics/dbml

dbx

Last synced: 5 days ago
JSON representation

Database Markup Language (DBML), designed to define and document database structures

Awesome Lists containing this project

README 

        
# DBML - Database Markup Language






[![Build Status](https://img.shields.io/github/actions/workflow/status/holistics/dbml/test.yml?label=CI&logo=github&style=flat-square)](https://github.com/holistics/dbml/actions/workflows/test.yml)

[![npm @dbml/core](https://img.shields.io/npm/v/@dbml/core?style=flat-square&label=npm%20@dbml/core)](https://www.npmjs.org/package/@dbml/core)

[![npm @dbml/core downloads](https://img.shields.io/npm/dm/@dbml/core.svg?style=flat-square)](https://npm-stat.com/charts.html?package=@dbml/core)

[![npm @dbml/cli](https://img.shields.io/npm/v/@dbml/cli?style=flat-square&label=npm%20@dbml/cli)](https://www.npmjs.org/package/@dbml/cli)

[![npm @dbml/cli downloads](https://img.shields.io/npm/dm/@dbml/cli.svg?style=flat-square)](https://npm-stat.com/charts.html?package=@dbml/cli)





DBML (database markup language) is a simple, readable DSL language designed to define database structures.



For more information, please check out [DBML homepage](https://dbml.dbdiagram.io)



## 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 visualiser at [dbdiagram.io](https://dbdiagram.io)

- Also comes with a free database documentation app at [dbdocs.io](https://dbdocs.io)



## Example



Example of a database definition of a simple blogging site:



    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



## Community Contributions



* [Emacs Mode for DBML (Contributed by ccod)](https://github.com/ccod/dbd-mode)

* [Vim Plugin for DBML (Contributed by jidn)](https://github.com/jidn/vim-dbml)

* [VSCode Plugin for DBML by duynvu](https://marketplace.visualstudio.com/items?itemName=duynvu.dbml-language)

* [Python parser for DBML by Vanderhoof](https://github.com/Vanderhoof/PyDBML)

* [FloorPlan: Android's Room to DBML by julioz](https://github.com/julioz/FloorPlan)

* [Go parser for DBML by duythinht](https://github.com/duythinht/dbml-go)

* [DbmlForDjango: Converter between Django models.py and DBML](https://github.com/hamedsj/DbmlForDjango)

* [parseServerSchema2dbml: Converter between ParseServer MongoDB \_SCHEMA collection and DBML by stepanic](https://github.com/stepanic/parse-server-SCHEMA-to-DBML)

* [dbml-renderer: A DBML CLI renderer](https://github.com/softwaretechnik-berlin/dbml-renderer)

* [dbml-parser: A DBML parser written on PHP8 by Butschster](https://github.com/butschster/dbml-parser)

* [Kacher: Laravel's Database Schemas to DBML by Arsanandha Aphisitworachorch](https://github.com/aphisitworachorch/kacher)

* [d365fo-entity-schema: Generate DBML from Dynamics 365 Finance and Operations ](https://github.com/noakesey/d365fo-entity-schema)

* [DB2Code: Generate DBML from Maven](https://github.com/alberlau/DB2Code)

* [dbml-java: A DBML parser written on Java 17 by Nils Wende](https://github.com/nilswende/dbml-java)

* [SchemaToDbml: A gem that generates DBML from Rails schema.rb by Ricardo Ribeiro](https://github.com/ricardojcribeiro/schema_to_dbml)

* [Snowflake DBML Generator by 	Ryan Rozich](https://github.com/ryanrozich/snowflake-dbml-generator)