Tạo từ điển dữ liệu

ErdDocs tạo từ điển dữ liệu từ bản dump SQL, lược đồ Prisma hoặc model của framework. Mọi bảng, cột, kiểu, giá trị mặc định, chỉ mục và quan hệ được gom vào một tài liệu tham chiếu. Bạn lưu tài liệu thành PDF qua hộp thoại in của trình duyệt, và có sơ đồ ERD ngay bên cạnh. Không cần đăng ký hay cài đặt. Lược đồ được phân tích trong trình duyệt.

Lược đồ của bạn

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS 'Khách hàng đã đăng ký; mỗi người một dòng';
COMMENT ON COLUMN customers.email IS 'Email đăng nhập, duy nhất trong toàn cửa hàng';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS 'Danh mục sản phẩm; sản phẩm đã xóa vẫn giữ SKU';
COMMENT ON COLUMN products.stock IS 'Số lượng tồn kho, cập nhật từ kho hàng';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS 'pending -> paid -> shipped -> done, hoặc cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS 'Chi tiết đơn hàng; đơn giá cố định lúc mua';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS 'Khách hàng đã đăng ký; mỗi người một dòng';
COMMENT ON COLUMN customers.email IS 'Email đăng nhập, duy nhất trong toàn cửa hàng';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS 'Danh mục sản phẩm; sản phẩm đã xóa vẫn giữ SKU';
COMMENT ON COLUMN products.stock IS 'Số lượng tồn kho, cập nhật từ kho hàng';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS 'pending -> paid -> shipped -> done, hoặc cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS 'Chi tiết đơn hàng; đơn giá cố định lúc mua';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

Your diagram appears here.

Lược đồ bên dưới có chú thích bằng tiếng Việt. Mở tab «Từ điển dữ liệu» để xem chúng trong cột mô tả.

Từ cơ sở dữ liệu tới từ điển trong ba bước

01Xuất lược đồ: pg_dump --schema-only mydb > schema.sql với PostgreSQL, mysqldump --no-data mydb > schema.sql với MySQL, hoặc lấy nguyên tệp schema.prisma của Prisma.
02Dán vào khung phía trên hoặc thả tệp vào. Từ điển hiện ra ngay khi lược đồ được đọc.
03Bấm Lưu thành PDF, hộp thoại in của trình duyệt sẽ tạo tài liệu. Bước này cũng không đi qua máy chủ nào.

Mô tả lấy từ chính lược đồ của bạn

Cơ sở dữ liệu vốn đã có chỗ để ghi mô tả, nhưng các mô tả đó hiếm khi được đưa vào một tài liệu hoàn chỉnh.

PostgreSQL: COMMENT ON TABLE orders IS '…' và COMMENT ON COLUMN orders.status IS '…'. pg_dump tự xuất chúng cùng lược đồ.
MySQL: mệnh đề COMMENT '…' trên cột và bảng trong CREATE TABLE. mysqldump giữ nguyên chúng.
Prisma: chú thích tài liệu /// phía trên model và trường sẽ thành mô tả trong từ điển.

Cột Mô tả lấy nội dung từ các chú thích này. Nếu lược đồ không có chú thích, cột này sẽ không xuất hiện, nên tài liệu không có ô trống.

Mọi thứ khác được đọc từ chính DDL. Đó là kiểu dữ liệu đúng như khi viết, có cho phép NULL không, giá trị mặc định, khóa, chỉ mục, và các phân vùng gom dưới bảng cha. Có bản dump không khai báo khóa ngoại nào (Rails và Django hiếm khi khai báo). Khi đó, quan hệ được khôi phục từ tên cột và được đánh dấu là suy ra. Nhờ vậy, kiểm toán viên luôn phân biệt được khóa khai báo với khóa suy ra.

Ai cần từ điển dữ liệu

Kiểm toán và tuân thủ. «Gửi chúng tôi từ điển dữ liệu» là yêu cầu quen thuộc. ErdDocs trả lời yêu cầu đó trong vài phút từ bản dump lược đồ bạn dán. Tự soạn bằng tay trên cơ sở dữ liệu đang chạy thì mất nhiều ngày.
Bàn giao cho khách hàng. Các agency kết thúc dự án bằng tài liệu. ErdDocs làm ra tài liệu đó, khách hàng in ra và giữ lại được.
Người mới vào nhóm. Kỹ sư mới đọc một tài liệu duy nhất, thay vì truy vấn information_schema từng bảng một.
Đồ án và bài tập. Từ điển dữ liệu cũng thường được yêu cầu cùng sơ đồ ERD.

Từ điển dữ liệu là gì?

Đó là tài liệu mô tả cơ sở dữ liệu theo từng bảng. Với mỗi trường, tài liệu ghi tên, kiểu, có cho phép NULL không và giá trị mặc định. Tài liệu cũng liệt kê khóa chính, khóa ngoại, chỉ mục và giải thích mỗi bảng lưu gì. Nó được yêu cầu trong đồ án, kiểm toán và khi bàn giao hệ thống cho khách hàng.

Tốt hơn mẫu Excel hay Word

Mẫu phải điền bằng tay, và nó lệch khỏi cơ sở dữ liệu ngay khi ai đó đổi một bảng. Ở đây bạn chỉ cần dán lại bản dump là từ điển được cập nhật. Vì vậy, bạn có thể tạo lại nó cho mỗi lần bàn giao.

Câu hỏi thường gặp

Từ điển dữ liệu được tạo ra gồm những gì?

ErdDocs mô tả mọi bảng. Với mỗi bảng, nó liệt kê các cột với kiểu dữ liệu đúng như khai báo, có cho phép NULL không và giá trị mặc định. Nó thêm khóa chính, khóa ngoại cùng cột mà khóa trỏ tới, ràng buộc duy nhất, chỉ mục, và cả hai chiều của mỗi quan hệ. Chú thích bảng và cột trong lược đồ trở thành mô tả. Bảng phân vùng chỉ được liệt kê một lần, các phân vùng ghi tên dưới bảng cha.

Làm sao tạo từ điển dữ liệu cho một cơ sở dữ liệu đã có?

Xuất lược đồ ra SQL. Với PostgreSQL, dùng pg_dump --schema-only. Với MySQL, dùng mysqldump --no-data. Dán kết quả vào khung phía trên và mở tab «Từ điển dữ liệu». In trang từ trình duyệt là bạn có PDF. Không cần cài gì, và SQL không rời máy bạn.

Mô tả vào từ điển bằng cách nào?

Từ chính lược đồ. Câu lệnh COMMENT ON TABLE và COMMENT ON COLUMN của PostgreSQL, mệnh đề COMMENT 'nội dung' của MySQL và chú thích tài liệu /// của Prisma đều vào cột Mô tả. Nếu lược đồ không có chú thích nào, ErdDocs bỏ hẳn cột Mô tả thay vì in cột trống.

Có miễn phí không?

Sơ đồ được vẽ miễn phí tới 25 bảng. Từ điển mô tả đầy đủ ba bảng có nhiều liên kết nhất. Các bảng tiếp theo hiện dưới dạng khung có tên, ở đúng vị trí của chúng, và số bảng còn lại được đếm. Như vậy đủ để bạn thấy đúng tài liệu mình sẽ nhận. Một lần thanh toán 9 USD sẽ mở toàn bộ từ điển và toàn bộ sơ đồ. Không thuê bao, không gia hạn, không tài khoản.

Lược đồ có bị tải lên đâu không?

Không. Phân tích, sơ đồ và từ điển đều diễn ra trong trình duyệt. PDF cũng do chính trình duyệt tạo khi in trang. Lược đồ không tới máy chủ nào, vì không có nơi nào để tải nó lên.

Xem thêm

Tạo từ điển dữ liệu cho MySQL: đặc điểm của mysqldump, cú pháp COMMENT trên cùng dòng.
Tạo từ điển dữ liệu cho PostgreSQL: cách dùng pg_dump, COMMENT ON, phân vùng.
Mẫu từ điển dữ liệu: bảy cột, một tệp CSV để tải về, và cách điền từng cột bằng tay.
Công cụ viết tài liệu cơ sở dữ liệu: so sánh các trình tạo mã nguồn mở, công cụ code-first và nền tảng.
Thay thế Dataedo: khi một tài liệu là đủ, còn một nền tảng là quá nhiều.
SQL sang sơ đồ ERD: cùng công cụ, mở sẵn ở chế độ sơ đồ.
Agent Link API: liên kết bất kỳ lược đồ nào tới sơ đồ và từ điển trực tiếp, từ README hay từ câu trả lời của AI.