如何快速生成数据库设计文档

背景介绍

在日复一日的数据库开发和运维工作中，工程师们常常遇到如此困扰：如何高效详尽地记录数据库结构，以便于快速查询和定位问题？如果能有一款工具自动将数据库结构转化成详尽的文档，灵活又简便，岂不美哉？

今天要给大家推荐一个 GitHub 开源项目 k1LoW/tbls，该项目在 GitHub 有超过 2.9k Star，用一句话介绍该项目就是：“tbls is a CI-Friendly tool for document a database, written in Go.”。

项目介绍

tbls 是一个为数据库文档化设计，易于与持续集成（CI）工具配合使用的工具，使用 Go 语言编写。它的核心功能包括：

1、自动完成数据库文档的生成并采用 GitHub 风格的 Markdown 格式输出，同时支持多种输出格式；

2、作为一个单一可执行文件，便于在 CI 场景下使用；

3、支持众多类型的数据库，并且可以作为数据库的语法检查工具。

以下是一个生成的示例：

数据库变更后可展示生成文档的变更 diff：

如何使用

安装 tbls，可以选择从 GitHub 发布页下载二进制文件手动安装，或者通过包管理工具如 deb、RPM、Homebrew 实现快速安装。

待安装完毕，你只需要简单的一条命令 tbls doc，便可以自动为数据库生成相应的文档。在生成文档的过程中，tbls 会读取配置文件（.tbls.yml）中的数据库连接信息以及文档生成的路径信息。如果你希望对生成的文档内容有更多个性化的要求，也可以通过配置文件设定诸多细节，如表格过滤、ER图生成、注释添加等。

项目推介

tbls 项目目前活跃度较高，版本更新频次也较高，反映出项目维护者的积极态度。此外，它还支持各种流行的数据库，如 PostgreSQL，MySQL，SQLite 等，可满足你在各种场景下的需求。

更多项目详情请查看如下链接。

开源项目地址：https://github.com/k1LoW/tbls

开源项目作者：k1LoW