DBスキーマをGitHubで管理したい

はじめに

開発の途中で、DBの構造がころころ変わるのはよくあることです。構造を変えるたびにレビューが必要な場合は、GitHubでDBスキーマを管理できると便利ですよね。DBスキーマがテキストファイル形式であり、DBスキーマからERDを生成するビジュアライザもあれば完璧ですよね。

できます。そう、DBMLならね。

DBML - Database Markup Language

DBMLはHolisticsという会社が開発したDSLで、DBスキーマを記述するために使います。特定のDBのSQLに縛られない形式なので、DBMLから各種DBのSQL DDLに変換することができます。

たとえば、以下のDBMLは

Table users {
    id int [pk, increment]
    name varchar(255)
    email varchar(255) [unique]
    password varchar(255)
    created_at timestamp
    updated_at timestamp
}

MySQLのSQL DDLに変換すると

CREATE TABLE `users` (
  `id` int PRIMARY KEY AUTO_INCREMENT,
  `name` varchar(255),
  `email` varchar(255) UNIQUE,
  `password` varchar(255),
  `created_at` timestamp,
  `updated_at` timestamp
);

SQL ServerのSQL DDLに変換すると

CREATE TABLE [users] (
  [id] int PRIMARY KEY IDENTITY(1, 1),
  [name] varchar(255),
  [email] varchar(255) UNIQUE,
  [password] varchar(255),
  [created_at] timestamp,
  [updated_at] timestamp
)
GO

なお、DBMLの詳しい文法は以下のドキュメントに書かれています。

www.dbml.org

また、Holistics社はDBMLだけではなく、DBMLからERDを自動生成するビジュアライザ(dbdiagram)も開発しています。ビジュアライザにDBMLを入力すると、以下のようにERDを生成します。