开源项目tbls使用教程

开源项目tbls使用教程

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

1. 项目介绍

tbls（发音为/ˈteɪbl̩z/）是一个CI友好的数据库文档工具，用Go语言编写。它可以自动将数据库文档化为GFM（GitHub Flavored Markdown）格式，并以多种格式输出数据库架构。tbls的特点包括：

• 自动化文档生成。
• 支持多种数据库。
• 作为数据库的代码检查工具。
• 支持持续集成。

2. 项目快速启动

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

安装tbls

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

• 下载最新版本的二进制文件。
• 使用go install命令安装。
• 使用包管理器，例如Homebrew或Docker。

例如，使用go install命令：

go install github.com/k1LoW/tbls@latest

配置项目

在你的项目中，创建一个.tbls.yml文件，配置数据库的连接字符串和文档输出路径。

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

确保如果密码中包含特殊字符，对密码进行URL编码。

文档生成

运行以下命令生成数据库文档：

tbls doc

生成的文档会放在你指定的docPath路径中。

提交文档

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

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

3. 应用案例和最佳实践

案例一：集成到持续集成流程

你可以在GitHub Actions中添加tbls的流程，以自动化文档的生成和更新。

name: Document

on: push

branches:
  - main

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规则，你可以使用tbls来检查数据库中的问题。

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

运行以下命令进行代码检查：

tbls lint

4. 典型生态项目

目前，tbls已经有一些典型的生态项目，例如：

• ghcr.io/k1low/tbls:latest：Docker镜像，可以用来在容器中运行tbls。
• 其他社区成员贡献的工具和插件，用于扩展tbls的功能。

使用tbls可以帮助开发者更好地管理和文档化数据库架构，从而提高开发效率和项目质量。

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