SqlFormatter 技术文档

SqlFormatter 技术文档

sql-formatter A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting. 项目地址: https://gitcode.com/gh_mirrors/sqlfo/sql-formatter

1. 安装指南

1.1 使用 Composer 安装

SqlFormatter 可以通过 Composer 进行安装。首先，确保你已经安装了 Composer。然后在你的项目根目录下运行以下命令：

composer require doctrine/sql-formatter

1.2 手动安装

如果你不想使用 Composer，也可以手动下载 SqlFormatter 的源码并将其放置在你的项目目录中。你可以从 GitHub 仓库 下载源码。

2. 项目使用说明

2.1 基本用法

SqlFormatter 提供了一个 format 方法，用于格式化 SQL 查询字符串。以下是一个基本的使用示例：

<?php
require_once 'vendor/autoload.php';

use Doctrine\SqlFormatter\SqlFormatter;

$query = "SELECT count(*),`Column1`,`Testing`, `Testing Three` FROM `Table1`
    WHERE Column1 = 'testing' AND ( (`Column2` = `Column3` OR Column4 >= NOW()) )
    GROUP BY Column1 ORDER BY Column3 DESC LIMIT 5,10";

echo (new SqlFormatter())->format($query);

2.2 仅格式化（无语法高亮）

如果你不需要语法高亮，只想进行缩进和换行，可以使用 NullHighlighter：

<?php

use Doctrine\SqlFormatter\NullHighlighter;
use Doctrine\SqlFormatter\SqlFormatter;

echo (new SqlFormatter(new NullHighlighter()))->format($query);

2.3 仅语法高亮

如果你已经有格式良好的 SQL 查询，只想添加语法高亮，可以使用 highlight 方法：

<?php
echo (new SqlFormatter())->highlight($query);

2.4 压缩查询

compress 方法可以移除所有注释并压缩空白，适用于需要直接复制到命令行的查询：

echo (new SqlFormatter())->compress($query);

3. 项目 API 使用文档

3.1 SqlFormatter 类

3.1.1 format(string $sql, ?HighlighterInterface $highlighter = null): string

• 参数:
  • $sql: 需要格式化的 SQL 字符串。
  • $highlighter: 高亮器实例，默认为 HtmlHighlighter。
• 返回值: 格式化后的 SQL 字符串。

3.1.2 highlight(string $sql): string

• 参数:
  • $sql: 需要高亮的 SQL 字符串。
• 返回值: 高亮后的 SQL 字符串。

3.1.3 compress(string $sql): string

• 参数:
  • $sql: 需要压缩的 SQL 字符串。
• 返回值: 压缩后的 SQL 字符串。

3.2 HighlighterInterface 接口

SqlFormatter 支持多种高亮器，你可以实现 HighlighterInterface 接口来自定义高亮器。

4. 项目安装方式

SqlFormatter 可以通过 Composer 或手动下载源码进行安装。推荐使用 Composer 进行安装，因为它可以自动管理依赖关系并确保你使用的是最新版本。

4.1 使用 Composer 安装

composer require doctrine/sql-formatter

4.2 手动下载源码

从 GitHub 仓库 下载源码，并将其放置在你的项目目录中。

---

通过以上文档，你应该能够顺利安装和使用 SqlFormatter 来格式化和美化你的 SQL 查询。如果你有任何问题或需要进一步的帮助，请参考项目的 GitHub 仓库或联系项目维护者。

sql-formatter A lightweight php class for formatting sql statements. Handles automatic indentation and syntax highlighting. 项目地址: https://gitcode.com/gh_mirrors/sqlfo/sql-formatter