PostgreSQL 存储过程代码审查自动化：plpgsql_check 批量检查脚本

PostgreSQL 存储过程代码审查自动化：plpgsql_check 批量检查脚本

【免费下载链接】plpgsql_checkplpgsql_check is a linter tool (does source code static analyze) for the PostgreSQL language plpgsql (the native language for PostgreSQL store procedures).项目地址: https://gitcode.com/gh_mirrors/pl/plpgsql_check

plpgsql_check 是 PostgreSQL 存储过程（plpgsql）的静态代码分析工具，能帮助开发者在部署前自动检测语法错误、性能隐患和逻辑问题。本文将详细介绍如何利用 plpgsql_check 实现存储过程的批量检查，提升数据库开发效率和代码质量。

📋 核心功能：为什么选择 plpgsql_check？

plpgsql_check 作为 PostgreSQL 生态中专业的代码审查工具，具备三大核心优势：

• 多维度检查：覆盖语法错误、变量未使用、类型不匹配、游标泄漏等 20+ 种问题
• 性能优化建议：识别全表扫描、低效索引使用等性能瓶颈
• 兼容多种 PostgreSQL 版本：支持从 14 到 20 的所有主流版本，对应脚本位于 sql/ 目录下，如 plpgsql_check_active-14.sql、plpgsql_check_active-20.sql

🔧 快速安装：3 步完成部署

1. 克隆仓库

git clone https://gitcode.com/gh_mirrors/pl/plpgsql_check cd plpgsql_check

2. 编译安装

根据 PostgreSQL 版本执行对应安装脚本：

# 以 PostgreSQL 16 为例 make PG_CONFIG=/usr/local/pgsql-16/bin/pg_config install

3. 启用扩展

在目标数据库中执行：

CREATE EXTENSION plpgsql_check;

🚀 批量检查实战：从单函数到全库扫描

基础：检查单个函数

使用plpgsql_check_function函数检查指定存储过程：

-- 检查名为 'test_function' 的函数 SELECT * FROM plpgsql_check_function('test_function'); -- 启用性能警告检查 SELECT * FROM plpgsql_check_function('test_procedure', performance_warnings=>true);

进阶：批量检查整个模式

通过系统表pg_proc结合plpgsql_check_function实现批量扫描：

-- 检查 public 模式下所有 plpgsql 函数 SELECT p.oid::regprocedure AS function_name, c.* FROM pg_proc p JOIN pg_language l ON p.prolang = l.oid CROSS JOIN LATERAL plpgsql_check_function(p.oid) c WHERE l.lanname = 'plpgsql' AND p.pronamespace = 'public'::regnamespace;

高级：自定义扫描脚本

项目提供了灵活的自定义扫描示例，可在 examples/custom_scan_function.sql 中找到模板：

-- 自定义扫描函数示例 CREATE FUNCTION plpgsql_check_custom( funcoid oid DEFAULT NULL, warns boolean DEFAULT false, stop_fatal boolean DEFAULT true, msg_like text DEFAULT '%', proname_regex text DEFAULT '^(.*)$', schema_regex text DEFAULT '^(.*)$' )

📊 检查结果解读

plpgsql_check 返回的结果包含关键信息：

• functionid：函数 OID
• lineno：问题所在行号
• message：详细错误/警告信息
• severity：严重级别（ERROR/WARNING/NOTE）

示例输出：

functionid | lineno | message | severity ------------+--------+--------------------------+---------- 12345 | 15 | variable "temp_var" is not used | WARNING 12346 | 28 | division by zero possible | ERROR

💡 最佳实践与注意事项

1. 集成到 CI/CD 流程：在数据库变更部署前自动执行检查，配置示例可参考 Makefile
2. 定期全库扫描：建议每周执行一次全库检查，及时发现历史代码隐患
3. 性能平衡：对大型数据库可分批次扫描，避免资源占用过高
4. 版本匹配：确保使用与 PostgreSQL 版本对应的检查脚本，如 PostgreSQL 16 应使用 plpgsql_check_active-16.sql

📚 扩展资源

• 官方文档：README.md
• 问题排查：TODO.md
• 编译配置：README.meson_msvc

通过 plpgsql_check 实现存储过程的自动化代码审查，不仅能显著减少生产环境的潜在风险，还能大幅提升团队的开发效率。立即尝试将其集成到你的 PostgreSQL 开发流程中，让代码质量管控变得简单高效！

【免费下载链接】plpgsql_checkplpgsql_check is a linter tool (does source code static analyze) for the PostgreSQL language plpgsql (the native language for PostgreSQL store procedures).项目地址: https://gitcode.com/gh_mirrors/pl/plpgsql_check