【回顧】一條命令快速生成數(shù)據(jù)庫文檔
共 1260字，需瀏覽 3分鐘
·
2024-06-16 19:30
大家好，又見面了，我是 GitHub 精選君！
背景介紹
在日復一日的數(shù)據(jù)庫開發(fā)和運維工作中，工程師們常常遇到如此困擾：如何高效詳盡地記錄數(shù)據(jù)庫結構，以便于快速查詢和定位問題？如果能有一款工具自動將數(shù)據(jù)庫結構轉化成詳盡的文檔，靈活又簡便，豈不美哉？
今天要給大家推薦一個 GitHub 開源項目 k1LoW/tbls，該項目在 GitHub 有超過 2.8k Star，用一句話介紹該項目就是：“tbls is a CI-Friendly tool for document a database, written in Go.”。
項目介紹
tbls 是一個為數(shù)據(jù)庫文檔化設計，易于與持續(xù)集成（CI）工具配合使用的工具，使用 Go 語言編寫。它的核心功能包括：
1、自動完成數(shù)據(jù)庫文檔的生成并采用 GitHub 風格的 Markdown 格式輸出，同時支持多種輸出格式；
2、作為一個單一可執(zhí)行文件，便于在 CI 場景下使用；
3、支持眾多類型的數(shù)據(jù)庫，并且可以作為數(shù)據(jù)庫的語法檢查工具。
以下是一個生成的示例：
數(shù)據(jù)庫變更后可展示生成文檔的變更 diff：
如何使用
安裝 tbls，可以選擇從 GitHub 發(fā)布頁下載二進制文件手動安裝，或者通過包管理工具如 deb、RPM、Homebrew 實現(xiàn)快速安裝。
待安裝完畢，你只需要簡單的一條命令 tbls doc，便可以自動為數(shù)據(jù)庫生成相應的文檔。在生成文檔的過程中，tbls 會讀取配置文件（.tbls.yml）中的數(shù)據(jù)庫連接信息以及文檔生成的路徑信息。如果你希望對生成的文檔內容有更多個性化的要求，也可以通過配置文件設定諸多細節(jié)，如表格過濾、ER圖生成、注釋添加等。
項目推介
tbls 項目目前活躍度較高，版本更新頻次也較高，反映出項目維護者的積極態(tài)度。此外，它還支持各種流行的數(shù)據(jù)庫，如 PostgreSQL，MySQL，SQLite 等，可滿足你在各種場景下的需求。
以下是該項目 Star 趨勢圖（代表項目的活躍程度）：
更多項目詳情請查看如下鏈接。
開源項目地址：https://github.com/k1LoW/tbls
開源項目作者：k1LoW
以下是參與項目建設的所有成員：
關注我們，一起探索有意思的開源項目。
點擊如下卡片后臺回復：加群，與技術極客們一起交流人工智能、開源項目，一起成長。如果你正在尋求開源項目推廣、DevOps、AIGC 大模型、軟件開發(fā)等領域的付費服務，可參考推文了解詳情。