DevOps场景下如何验证.sql文件及PL/SQL、ORDS语法合法性

以下方案可完全覆盖普通SQL、PL/SQL块、ORDS相关代码的语法校验需求，无需依赖第三方工具，直接用Oracle原生功能实现：

1. 通用SQL/PL/SQL语法校验逻辑 #

核心采用Oracle原生的DBMS_SQL.PARSE能力，仅做语法解析不实际执行代码，可完美解决EXPLAIN PLAN FOR不支持PL/SQL的问题：

• 首先执行会话级配置，开启全量语法警告：

ALTER SESSION SET PLSQL_WARNINGS = 'ENABLE:ALL';
ALTER SESSION SET SQL_TRACE = FALSE;

• 编写通用校验脚本，将待校验的SQL文件内容传入即可：

DECLARE
  v_check_sql CLOB; -- 代入待校验的.sql文件完整内容
  v_cursor_id NUMBER;
BEGIN
  v_cursor_id := DBMS_SQL.OPEN_CURSOR;
  -- 最后一个参数设置为FALSE代表仅做语法解析，不执行实际逻辑
  DBMS_SQL.PARSE(v_cursor_id, v_check_sql, DBMS_SQL.NATIVE, FALSE);
  DBMS_SQL.CLOSE_CURSOR(v_cursor_id);
  DBMS_OUTPUT.PUT_LINE('SQL语法校验通过');
EXCEPTION
  WHEN OTHERS THEN
    IF DBMS_SQL.IS_OPEN(v_cursor_id) THEN
      DBMS_SQL.CLOSE_CURSOR(v_cursor_id);
    END IF;
    -- 抛出错误供流水线捕获判定校验失败
    RAISE_APPLICATION_ERROR(-20001, 'SQL语法错误：' || SQLERRM);
END;
/

如果.sql文件包含多条独立语句，需要先按/或者;做语句分割后逐段传入校验，避免批量解析异常

2. ORDS相关代码校验逻辑 #

ORDS的REST定义代码（如ORDS.DEFINE_SERVICE、ORDS.ENABLE_OBJECT这类存储过程调用）本身属于PL/SQL范畴，上述DBMS_SQL.PARSE已经可以覆盖基础语法校验，如果需要进一步校验ORDS参数合法性，可以新增以下校验逻辑：

DECLARE
  v_ords_code CLOB; -- 代入待校验的ORDS相关代码段
BEGIN
  -- 开启ORDS调试模式，仅校验参数合法性，不会实际创建REST服务
  ORDS.SET_CONFIG('runtime.debug', 'true');
  EXECUTE IMMEDIATE v_ords_code;
  -- 校验通过后回滚，不会生成实际ORDS配置
  ROLLBACK;
EXCEPTION
  WHEN OTHERS THEN
    ROLLBACK;
    RAISE_APPLICATION_ERROR(-20002, 'ORDS代码错误：' || SQLERRM);
END;
/

3. Jenkins流水线集成步骤 #

你可以把上述逻辑封装为独立的校验脚本，在流水线的预执行阶段调用：

• 拉取本次Gitlab提交的所有.sql格式文件
• 通过sqlplus或者Oracle JDBC连接到专门的校验用Oracle实例（建议用轻量Oracle XE空实例，无数据风险，不需要生产权限）
• 逐个调用校验逻辑，任意文件校验不通过直接终止流水线，返回对应的错误信息

内容的提问来源于stack exchange，提问作者Salvador Arreola Rojas