乐趣区

在线数据库关系图设计工具-dbdiagramio

前段时间,笔者在设计某个系统模块的时候,需要增加十几张表。

为了简单快速地把这十几张表设计并定义出来,我找到了一个可以在线设计数据库关系图 (database relationship diagram) 且可以导出 DDL SQL 的工具——dbdiagram.io。

dbdiagram.io 是 holistics.io 这款商业产品的社区版。

dbdiagram.io 使用 DSL 语言,可以简单快速地创建数据库关系图。

这款工具的操作界面也非常简约并具有设计感:

  • 有时候我们需要在关系型数据库中设计一些表,以便实现我们的业务功能。
  • 或者我们对某个系统的表结构不是很熟悉,希望画个图表示一下这些实体之间的关系。
  • 又或者我们希望把设计好的数据库关系图直接转化为 DDL SQL。
  • 而且我们不想使用复杂的工具,付出高昂的学习成本。
  • 也不想用太重的工具,占用内存。

这个时候这个在线的数据库关系图工具就排上用场了。

语法

下面介绍一下它的语法。

定义表的语法如下:

Table users {id integer [pk]
  username varchar [not null, unique]
  full_name type [not null]
  .....
}

如果表名太长还支持取别名:

Table longtablename as t_alias {.....}

定义外键支持如下三种关系:

< : One-to-many
> : Many-to-one
- : One-to-one

并且提供了 3 种定义外键的方式:

Ref name-optional {table1.field1 < table2.field2}

Ref name-optional: t1.f1 < t2.f2

Table posts {id integer [pk, ref: < comments.post_id]
  user_id integer [ref: > users.id]
}

例子

下面以电商系统常用的几张表作为例子演示一下它的用法。

当你登录自己的 Google 账号以后,可以把你设计好的图形保存到线上,这样就可以通过一个唯一的链接访问 : https://dbdiagram.io/d/5cc910…。

这里是 DSL:

Table orders {id int [primary key]
  user_id int [not null, unique]
  status varchar
  created_at varchar
}

Table order_items {
  order_id int
  product_id int
  quantity int
}

Table products {id int [primary key]
  name varchar
  merchant_id int [not null]
  price int
  status varchar
  created_at varchar
  category_id int
}

Table users {id int [primary key]
  full_name varchar
  email varchar [unique]
  gender varchar
  date_of_birth varchar
  created_at varchar
  country_code int
}

Table merchants {id int [primary key]
  admin_id int
  merchant_name varchar
  country_code int
  created_at varchar

}

Table categories {id int [primary key]
  cat_name varchar
  parent_id int
}

Table countries {code int [primary key]
  name varchar
  continent_name varchar
}

Ref {orders.user_id > users.id}
Ref {order_items.order_id > orders.id}

Ref {order_items.product_id > products.id}

Ref {products.merchant_id > merchants.id}

Ref {products.category_id > categories.id}

Ref {categories.parent_id > categories.id}

Ref {users.country_code > countries.code}

Ref {merchants.admin_id > users.id}

Ref {merchants.country_code > countries.code}

这里是导出的数据库关系图 PDF:

总结

最后总结一下 dbdiagram.io 的特点:

  • DSL:使用简单的 DSL 语言即可定义数据库关系图
  • Google Account:使用 Google 账号可以在线保存设计好的图
  • Online:不需要安装软件,方便快捷,而且支持拖动和调节
  • Import/Export : 支持导出 DDL SQL 和 PDF,支持导入外部数据
  • Share : 可以生成一个分享链接,方便团队成员协作

退出移动版