koriym/query-locator

从文件加载和管理 SQL 查询

1.5.1 2024-06-10 03:13 UTC

This package is auto-updated.

Last update: 2024-09-10 03:55:56 UTC


README

Scrutinizer Code Quality codecov Continuous Integration

Koriym.QueryLocator 是一个 PHP 库,可以帮助您通过定位和从文件系统中加载 SQL 查询来管理 SQL 查询。这种方法简化了查询管理并提高了代码的可读性。

安装

使用 Composer 安装库

$ composer require koriym/query-locator

使用方法

基本示例

要使用 QueryLocator 类,请用存储 SQL 文件的目录实例化它。然后,您可以使用对应于目录结构的键来检索查询。

SQL 文件目录结构

└── sql
    └── admin
        └── user.sql

代码示例

use Koriym\QueryLocator\QueryLocator;

// Define the directory where your SQL files are stored
$sqlDir = 'path/to/sql/files';

// Instantiate the QueryLocator
$query = new QueryLocator($sqlDir);

// Retrieve a query
$sql = $query['admin/user']; // This will load the contents of 'admin/user.sql'

// Retrieve a count query
$countSql = $query->getCountQuery('admin/user'); // This will generate 'SELECT COUNT(*) FROM user'

特性

  • 基于文件的查询管理:将您的 SQL 查询存储在单独的文件中,以获得更好的组织。
  • 简单的查询检索:使用基于目录的键来检索查询。
  • 计数查询生成:自动生成计数查询。

优势

  • 提高可读性:通过将 SQL 查询移动到专用文件,使您的 PHP 代码保持整洁和可读。
  • 易于维护:只需更新 SQL 文件,无需更改 PHP 代码即可修改您的 SQL 查询。
  • 结构化组织:以对您的应用程序有意义的目录结构组织您的查询。