davidlienhard/database-query-validator

🐘 PHP 工具用于验证数据库查询

0.4.7 2022-11-07 21:01 UTC

README

🐘 使用 davidlienhard/database 编写的 PHP 工具,用于验证数据库查询

Latest Stable Version Source Code Software License Minimum PHP Version CI Status

配置

此工具需要在主项目目录中名为 query-validator.json 的文件。目前不支持 CLI 参数。以下是一些可能的配置选项

  • paths (array): 要扫描的路径(文件夹或文件)列表。
  • exclusions (array): 要从扫描中排除的路径列表
  • dumpfile (string): 用于类型检查的 MySQL 导出文件路径
  • parameters (object)
    • ignoresyntax (bool): 是否忽略查询中的语法错误
    • strictinserts (bool): 检查插入是否包含所有设置为非空的文本列
    • strictinsertsignoremissingtablenames (bool): 在严格导入时,是否忽略无法提取表名的查询

所有路径相对于配置文件路径。如果找不到配置文件,则将扫描当前文件夹中的所有文件。

示例配置文件

JSON

{
    "paths": [
        "src"
    ],
    "exclusions": [
        "**/exclude.php"
    ],
    "dumpfile": "dump.sql",
    "parameters": {
        "ignoresyntax": false,
        "strictinserts": false
    }
}

YAML

paths:
  - src
exclusions:
  - "**/exclude.php"
dumpfile: dump.sql
parameters:
  ignoresyntax: false
  strictinserts: false

待办事项

该项目仍在开发中,还有很多工作要做。

  • 改进查询验证
  • 改进文档(当然)
  • 添加单元测试
  • 改进数据库查询识别
  • 改进配置
    • 添加 CLI 参数支持

许可证

MIT 许可证(MIT)。请参阅LICENSE 获取更多信息。