OpenAPI 流水线集成

当平台没有 PawSQL 预置连接器，或组织希望完全控制 SQL 提取和门禁逻辑时，可在流水线中调用 PawSQL OpenAPI。

目标

在任意 CI/CD 流水线中调用 PawSQL，提交变更 SQL、等待审核结果并设置构建状态。

确定比较基线

合并请求使用目标分支的共同祖先；普通构建使用组织定义的稳定提交或上一次成功构建。

提取 SQL

仅收集受支持的 SQL 文件和迁移脚本，并保持文件名、行号和语句顺序等定位信息。

创建工单

按 OpenAPI 参考文档传入工作空间、审核策略、SQL 内容和外部运行标识。

等待完成

使用有限次数的轮询或回调获取工单状态；采用退避策略，避免高频请求。

读取结果

获取工单摘要和详细问题，并区分业务违规、语法错误、系统错误和超时。

执行门禁

将 PawSQL 结果映射为成功、警告或失败退出码，并归档报告。

PAWSQL_BASE_URL
PAWSQL_ACCESS_TOKEN
PAWSQL_WORKSPACE_ID
PAWSQL_POLICY_ID
PAWSQL_TIMEOUT_SECONDS

变量名称可以根据组织规范调整。访问令牌必须由流水线 Secret 存储注入，不应写入脚本或配置仓库。

本页说明调用模式，不重复列出接口字段。请求路径、参数、响应结构和错误码以对应版本的 PawSQL OpenAPI 文档为准。

确认门禁结果正确映射为成功、警告或失败退出码，并归档了报告。

完成SQL 质量门禁与结果回传，再根据平台流水线语法实现调用脚本。Jenkins、GitHub Actions、GitLab CI 和 Azure Pipelines 均属于此类非预置集成。