开源项目tbls使用教程

开源项目tbls使用教程

tbls tbls is a CI-Friendly tool to document a database, written in Go. 项目地址: https://gitcode.com/gh_mirrors/tb/tbls

1. 项目介绍

tbls是一个使用Go语言编写的CI-Friendly数据库文档工具。它能够自动生成数据库的文档，并以GitHub友好Markdown格式输出。tbls支持多种数据库，可以作为数据库的静态代码分析工具，帮助开发者在持续集成过程中维护数据库的文档。

2. 项目快速启动

首先，确保你已经安装了Go语言环境。

安装tbls

可以通过以下方式安装tbls：

go install github.com/k1LoW/tbls@latest

或者，你可以从GitHub发布页面下载预编译的二进制文件。

配置文件

在你的项目根目录下创建一个.tbls.yml文件，用于配置数据库连接和文档输出路径。

dsn: postgres://dbuser:dbpass@localhost:5432/dbname
docPath: doc/schema

确保替换dsn中的数据库连接信息。

生成文档

使用以下命令生成数据库文档：

tbls doc

该命令将分析你的数据库，并在配置的docPath路径下生成Markdown格式的文档。

提交文档

将生成的文档和.tbls.yml配置文件添加到你的版本控制系统中：

git add .tbls.yml doc/schema
git commit -m "Add database document"
git push origin main

3. 应用案例和最佳实践

持续集成

你可以在持续集成流程中使用tbls来自动化文档的生成和更新。下面是一个使用GitHub Actions的示例。

name: Document

on: [push]

jobs:
  doc:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout .tbls.yml
        uses: actions/checkout@v3
      - uses: k1low/setup-tbls@v1
      - name: Run tbls for generate database document
        run: tbls doc

代码审查

tbls还可以用来作为数据库的代码审查工具。通过配置.tbls.yml中的lint选项，可以对数据库列的注释和列数进行限制。

lint:
  requireColumnComment:
    enabled: true
    exclude:
      - id
      - created
      - updated
  columnCount:
    enabled: true
    max: 10

然后运行以下命令进行审查：

tbls lint

4. 典型生态项目

tbls作为一个数据库文档工具，在生态中通常与各种数据库和持续集成工具配合使用。以下是一些典型的搭配：

• 与PostgreSQL、MySQL等数据库结合，自动生成文档。
• 在Jenkins、Travis CI、GitLab CI等CI/CD工具中集成，实现自动化文档更新。
• 作为开发过程中的一部分，帮助团队维护和同步数据库设计和文档。

以上就是tbls的简单使用教程，希望对你有所帮助。

tbls tbls is a CI-Friendly tool to document a database, written in Go. 项目地址: https://gitcode.com/gh_mirrors/tb/tbls