plpgsql_check 项目使用教程

plpgsql_check 项目使用教程

plpgsql_check plpgsql_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

1. 项目的目录结构及介绍

plpgsql_check/
├── examples/
│   ├── expected/
│   └── msvc/
├── sql/
├── src/
│   ├── editorconfig
│   ├── gitignore
│   ├── LICENSE
│   ├── META.json
│   ├── Makefile
│   ├── README.md
│   ├── TODO.md
│   ├── _config.yml
│   ├── plpgsql_check--2.7.sql
│   └── plpgsql_check.control
├── postgresql12-plpgsql_check.spec
├── postgresql13-plpgsql_check.spec
├── postgresql14-plpgsql_check.spec
├── postgresql15-plpgsql_check.spec
├── postgresql16-plpgsql_check.spec
└── postgresql17-plpgsql_check.spec

目录结构介绍

• examples/: 包含项目的示例代码，分为 expected/ 和 msvc/ 两个子目录。
• sql/: 包含与 SQL 相关的文件。
• src/: 项目的源代码目录，包含编辑器配置文件 editorconfig、Git 忽略文件 gitignore、许可证文件 LICENSE、元数据文件 META.json、Makefile 文件 Makefile、README 文件 README.md、TODO 文件 TODO.md、配置文件 _config.yml、SQL 文件 plpgsql_check--2.7.sql 和控制文件 plpgsql_check.control。
• postgresql12-plpgsql_check.spec 至 postgresql17-plpgsql_check.spec: 这些文件是针对不同 PostgreSQL 版本的规范文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/Makefile 和 src/plpgsql_check--2.7.sql。

Makefile

Makefile 是一个自动化构建工具，用于编译和构建项目。通过运行 make 命令，可以自动执行一系列的编译和构建操作。

plpgsql_check--2.7.sql

plpgsql_check--2.7.sql 是项目的核心 SQL 文件，包含了项目的核心逻辑和功能。通过在 PostgreSQL 中执行该文件，可以加载和启用 plpgsql_check 扩展。

3. 项目的配置文件介绍

项目的配置文件主要是 src/_config.yml 和 src/META.json。

_config.yml

_config.yml 是一个 YAML 格式的配置文件，用于配置项目的各种参数和选项。该文件通常用于配置项目的构建、部署和其他自动化任务。

META.json

META.json 是一个 JSON 格式的元数据文件，包含了项目的元数据信息，如版本号、依赖项等。该文件通常用于项目的包管理和发布。

通过以上介绍，您可以更好地理解和使用 plpgsql_check 项目。

plpgsql_check plpgsql_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