Введение

DBML (Database Markup Language) — простой и читаемый язык для описания структуры баз данных. Схема описывается текстом, поэтому её удобно хранить в Git, проводить ревью и сравнивать версии.

Table users {
  id integer [pk, increment]
  email varchar(255) [unique, not null]
  created_at timestamp [default: `now()`]
}

Table posts {
  id integer [pk]
  user_id integer [ref: > users.id]
  title varchar
}

Разделы

Документация разделена на части:

• Структура базы данных — конструкции, которые напрямую превращаются в SQL: проект и схемы, таблицы, столбцы, проверки, индексы, связи, перечисления, TablePartial и примеры данных.
• Основы языка — многострочные строки, комментарии, соглашения синтаксиса.
• Заметки и оформление — конструкции для диаграмм и документации: заметки, группы таблиц, цвета, пользовательские свойства, представления диаграмм.
• Зависимости данных — описание происхождения данных (Dep).
• Модульная система — разбиение схемы на несколько файлов.

Попробуйте

Откройте редактор DBML — код слева, диаграмма справа. Примеры из документации можно сразу вставить в редактор.

Редактор «Помощника» строит диаграмму по таблицам, столбцам, связям, перечислениям и группам таблиц. Часть возможностей (заметки на холсте, представления диаграмм, цвета связей, зависимости данных, импорт модулей) описана здесь для полноты и пока не отображается на диаграмме.

---

Документация основана на официальной документации DBML: dbml.dbdiagram.io/docs.