SQLC项目在CI/CD流水线中的最佳实践-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00504/article/details/148377503

SQLC项目在CI/CD流水线中的最佳实践

sqlc sqlc-dev/sqlcsqlc-dev/sqlcli: 是一个用于 PostgreSQL 和 SQLite 数据库的跨平台命令行工具，它提供了一个简单易用的界面用于管理 PostgreSQL 和 SQLite 数据库。适合用于管理 PostgreSQL 和 SQLite 数据库，特别是对于需要轻量级、跨平台的数据库管理工具的场景。特点是轻量级、跨平台、支持 PostgreSQL 和 SQLite 数据库。项目地址: https://gitcode.com/gh_mirrors/sq/sqlc

什么是SQLC

SQLC是一个强大的SQL查询编译器，它能将SQL语句转换为类型安全的Go代码。通过预编译SQL语句，SQLC可以帮助开发者避免运行时错误，提高开发效率。

为什么要在CI/CD中使用SQLC

在团队协作开发环境中，确保SQL查询和生成的代码始终保持一致至关重要。将SQLC集成到CI/CD流水线中可以带来以下好处：

自动检测代码差异
执行SQL查询静态分析
验证数据库模式变更
确保生产环境稳定性

核心CI/CD检查命令

1. sqlc diff - 代码差异检查

这个命令比较当前生成的代码与重新生成的代码之间的差异，确保开发者没有手动修改生成的代码或忘记重新生成代码。

典型使用场景：

新开发者加入项目时可能不了解需要重新生成代码
开发者可能无意中修改了生成的代码
确保团队所有成员使用相同版本的生成代码

2. sqlc vet - SQL静态分析

对SQL查询进行静态分析，检测潜在问题或反模式：

识别可能导致性能问题的查询
检查SQL注入风险
验证查询语法正确性
确保符合团队SQL编写规范

3. sqlc verify - 模式变更验证

验证数据库模式变更不会破坏现有查询：

检测删除的列是否被查询使用
检查类型变更是否兼容
验证约束变更的影响
确保索引变更不会导致查询性能下降

4. sqlc push - 项目存档

将当前项目状态推送到云端存档，为后续验证提供基准：

保存当前数据库模式
存储所有SQL查询定义
记录项目配置
为团队协作提供统一参考点

CI/CD流水线配置指南

基本设置

在构建环境中安装SQLC
配置三个独立的检查阶段：diff、vet和verify
在主分支合并后执行push操作

具体实现示例

差异检查阶段配置

steps:
- name: 检出代码
  uses: actions/checkout@v3
  
- name: 安装SQLC
  uses: sqlc-dev/setup-sqlc@v3
  with:
    sqlc-version: '1.29.0'

- name: 执行差异检查
  run: sqlc diff

SQL静态分析阶段配置

steps:
- name: 启动PostgreSQL
  uses: sqlc-dev/action-setup-postgres@master
  with:
    postgres-version: "16"
  id: postgres

- name: 执行静态分析
  run: sqlc vet
  env:
    POSTGRESQL_SERVER_URI: ${{ steps.postgres.outputs.connection-uri }}?sslmode=disable

验证阶段配置

steps:
- name: 启动数据库
  uses: sqlc-dev/action-setup-postgres@master
  with:
    postgres-version: "16"
  id: postgres

- name: 执行验证
  run: sqlc verify
  env:
    POSTGRESQL_SERVER_URI: ${{ steps.postgres.outputs.connection-uri }}?sslmode=disable
    SQLC_AUTH_TOKEN: ${{ secrets.SQLC_AUTH_TOKEN }}

项目存档阶段配置

steps:
- name: 安装SQLC
  uses: sqlc-dev/setup-sqlc@v3
  with:
    sqlc-version: '1.29.0'

- name: 推送项目存档
  run: sqlc push
  env:
    SQLC_AUTH_TOKEN: ${{ secrets.SQLC_AUTH_TOKEN }}