返回所有指南
ERD 工具··阅读约需 3 分钟

PostgreSQL ERD 生成器:可视化表、ENUM 和外键

从 CREATE TABLE、CREATE TYPE、标识列、索引和外键约束生成 PostgreSQL ER 图,并附有实际示例。

PostgreSQL BIGSERIAL 和 TIMESTAMPTZ 列以及客户到订单的外键图
在本指南中
  1. 为什么 PostgreSQL 模式需要良好的图表
  2. 值得可视化的 PostgreSQL 功能
  3. PostgreSQL DDL 示例
  4. Postgres ERD 工作流
  5. 参考资料与延伸阅读

除非另外命名了方言,否则 SQL 示例使用 PostgreSQL。简短的代码片段假定其引用的表已存在。在应用 DDL 之前,请在目标数据库中验证 DDL。

为什么 PostgreSQL 模式需要良好的图表

PostgreSQL 模式通常包含比简单表更多的内容。实际项目使用 ENUM 类型、标识列、架构限定名称、JSON 字段、数组类型、复合键、生成列、部分索引以及具有级联规则的外键。图表有助于团队比逐行阅读 DDL 更快地理解所有这些结构。

PostgreSQL ERD 生成器读取您的 DDL 并创建包含表、列、主键、外键和约束的实体关系图。 Erd Go SQL 转 ERD 编辑器 支持 PostgreSQL 风格的架构定义,因此您可以粘贴 DDL 并立即检查模型。

PostgreSQL DDL 和其他 SQL 方言汇入一个 Erd Go 图画布
PostgreSQL 具有丰富的 DDL 语法,但 ERD 仍需传达相同的基本要素:表、键、约束和关系。

值得可视化的 PostgreSQL 功能

选择 Postgres 图工作流时,请确保该工具了解您的应用程序实际使用的数据库功能。

  • 标识和序列列。 主键,例如 SERIAL, BIGSERIAL, 以及 GENERATED ALWAYS AS IDENTITY 应被识别为生成的标识符。
  • 自定义类型。 CREATE TYPE ... AS ENUM 值应保持可见,而不是被展平成通用字符串。
  • 外键。 内联 REFERENCES 和命名的表级约束都需要生成图关系。
  • 带模式限定的对象。 诸如 billing.invoices 和 auth.users 在图中应保持可理解。

PostgreSQL DDL 示例

将此示例粘贴到编辑器中以生成 PostgreSQL 风格的 ERD:

CREATE TYPE order_status AS ENUM ('draft', 'paid', 'shipped', 'cancelled');

CREATE TABLE customers (
    id          BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
    email       TEXT NOT NULL UNIQUE,
    full_name   TEXT NOT NULL,
    metadata    JSONB DEFAULT '{}'::jsonb,
    created_at  TIMESTAMPTZ NOT NULL DEFAULT now()
);

CREATE TABLE orders (
    id          BIGINT GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
    customer_id BIGINT NOT NULL REFERENCES customers (id),
    status      order_status NOT NULL DEFAULT 'draft',
    total       NUMERIC(12, 2) NOT NULL CHECK (total >= 0),
    tags        TEXT[] DEFAULT ARRAY[]::TEXT[],
    created_at  TIMESTAMPTZ NOT NULL DEFAULT now()
);

CREATE TABLE order_events (
    id          BIGSERIAL PRIMARY KEY,
    order_id    BIGINT NOT NULL REFERENCES orders (id) ON DELETE CASCADE,
    event_name  TEXT NOT NULL,
    payload     JSONB NOT NULL DEFAULT '{}'::jsonb,
    created_at  TIMESTAMPTZ NOT NULL DEFAULT now()
);

CREATE INDEX idx_orders_customer_id ON orders (customer_id);
CREATE INDEX idx_order_events_order_id ON order_events (order_id);

重要的关系是 customers → orders 和 orders → order_events。自定义枚举、JSONB 列、数组、检查和索引增加了实现细节,而没有隐藏核心数据模型。

Postgres ERD 工作流

对于使用 PostgreSQL 的团队,基于 SQL 的图表工作流通常是最可靠的。

  • 从迁移文件、架构转储或拉取请求中导出或复制当前 DDL。
  • 将其粘贴到 Erd Go 来自动生成图表。
  • 将重要表移入可读的集群中,例如 auth、billing、catalog 和 audit。
  • 在审查期间使用图表来检查缺失的外键和令人困惑的所有权边界。
  • 迁移批准后,从更新后的 DDL 重新生成 ERD,以便图表保持同步。

参考资料与延伸阅读

更多文章