# @gethue/sql-formatter 中文文档

规范地址：https://npmcn.com/package/%40gethue/sql-formatter/

版本：4\.0\.3
npm 元数据更新时间：2023-09-18T09:37:04.969Z
中文译文更新时间：2026-11-16T06:16:30.761Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gethue/sql-formatter
原文对照：https://npmcn.com/package/%40gethue/sql-formatter/?lang=original
项目主页：https://github.com/gethue/sql-formatter#readme
源码仓库：https://github.com/gethue/sql-formatter

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：800 kB，48 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2021-05-03T13:43:34.938Z
- 最新版本发布：2021-05-03T13:43:35.617Z
- 近 30 天下载量：9951（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

在 SQL 查询中格式化白空间使其更可读

## 安装

```sh
npm install @gethue/sql-formatter
```

也可以使用：`pnpm add @gethue/sql-formatter`、`yarn add @gethue/sql-formatter`、`bun add @gethue/sql-formatter`

## README

# SQL 格式文件 [![NPM version](https://img.shields.io/npm/v/sql-formatter.svg)](https://npmjs.com/package/sql-formatter) [![Build Status](https://travis-ci.org/zeroturnaround/sql-formatter.svg?branch=master)](https://travis-ci.org/zeroturnaround/sql-formatter) [![Coverage Status](https://coveralls.io/repos/github/zeroturnaround/sql-formatter/badge.svg?branch=master)](https://coveralls.io/github/zeroturnaround/sql-formatter?branch=master)

**SQL 格式文件** 是一个 JavaScript 库,用于打印 SQL 查询 . 它开始是一个港口 [PHP 库](https://github.com/jdorn/sql-formatter),但自那以后,已经有很大的分歧.

SQL formatter 支持下列方言: SQL 支持方言 :

-   **坐标** - 说吧 [标准 SQL](https://en.wikipedia.org/wiki/SQL:2011)
-   **马里亚德b** - 说吧 [马里亚DB](https://mariadb.com/)
-   **密苏里语name** - 说吧 [MySQL 数据](https://www.mysql.com/)
-   **邮政** - 说吧 [邮递SQL](https://www.postgresql.org/)
-   **(单位:千美元)** - 说吧 [IBM 数据库2](https://www.ibm.com/analytics/us/en/technology/db2/)
-   **缩写** - 说吧 [甲骨文 PL/SQL](http://www.oracle.com/technetwork/database/features/plsql/index.html)
-   **单位1ql** - 说吧 [库克碱 N1QL](http://www.couchbase.com/n1ql)
-   **红调** - 说吧 [亚马逊红移](https://docs.aws.amazon.com/redshift/latest/dg/cm_chap_SQLCommandRef.html)
-   **闪光** - 说吧 [闪光](https://spark.apache.org/docs/latest/api/sql/index.html)
-   **坐标** - 说吧 [SQL 服务器变换- SQL](https://docs.microsoft.com/en-us/sql/sql-server/)

它不支持:

-   库存程序.
-   将分隔符类型更改为非 `;`。 。 。 .

→ [试试演示.](https://zeroturnaround.github.io/sql-formatter/)

## 安装

从国家预防机制获取最新版本:

```sh
npm install sql-formatter
```

## 用作图书馆

```js
import { format } from 'sql-formatter';

console.log(format('SELECT * FROM tbl'));
```

这将输出 :

```sql
SELECT
  *
FROM
  tbl
```

您也可以通过配置选项 :

```js
format('SELECT * FROM tbl', {
  language: 'spark', // Defaults to "sql" (see the above list of supported dialects)
  indent: '    ', // Defaults to two spaces
  uppercase: bool, // Defaults to false (not safe to use when SQL dialect has case-sensitive identifiers)
  linesBetweenQueries: 2, // Defaults to 1,
  indentQuerySeparator: true, // Defaults to false
});
```

### 替换占位符

```js
// Named placeholders
format("SELECT * FROM tbl WHERE foo = @foo", {
  params: {foo: "'bar'"}
}));

// Indexed placeholders
format("SELECT * FROM tbl WHERE foo = ?", {
  params: ["'bar'"]
}));
```

两者都导致:

```
SELECT
  *
FROM
  tbl
WHERE
  foo = 'bar'
```

## 来自命令行的使用

CLI 工具将安装在 `sql-formatter` 并可通过 `npx sql-formatter`数字 :

```sh
sql-formatter -h
```

```
usage: sql-formatter [-h] [-o OUTPUT] [-l {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}]
                     [-i N | -t] [-u] [--lines-between-queries N] [--version] [FILE]

SQL Formatter

positional arguments:
  FILE                  Input SQL file (defaults to stdin)

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        File to write SQL output (defaults to stdout)
  -l {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql},
  --language {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}
                        SQL Formatter dialect (defaults to basic sql)
  -i N, --indent N      Number of spaces to indent query blocks (defaults to 2)
  -t, --tab-indent      Indent query blocks with tabs instead of spaces
  -u, --uppercase       Capitalize language keywords
  --lines-between-queries N
                        How many newlines to insert between queries (separated by ";")
  --version             show program's version number and exit
```

默认情况下,该工具会从 stdin 中获取查询并处理这些查询, 但 也可以命名输入文件名或使用 `--output` 选项.

```sh
echo 'select * from tbl where id = 3' | sql-formatter -u
```

```sql
SELECT
  *
FROM
  tbl
WHERE
  id = 3
```

## 没有国家预防机制的使用

如果你不使用模块捆绑器, 克隆寄存器, 运行 `npm install` 获取文件 `/dist` 要使用的目录 a `<script>` 标签. 这使得 SQL Formatter 作为全局变量可用 `window.sqlFormatter`。 。 。 .

## 捐款

确保运行所有检查 :

```sh
npm run check
```

...你准备用拉动请求戳我们.

## 许可证

[麻省理工学院](https://github.com/zeroturnaround/sql-formatter/blob/master/LICENSE)

## 常见问题

### @gethue/sql-formatter 是什么？

在 SQL 查询中格式化白空间使其更可读

### 如何安装 @gethue/sql-formatter？

在项目目录运行 npm install @gethue/sql-formatter，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 sql-formatter，可以用 npx sql-formatter 直接运行。

### @gethue/sql-formatter 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gethue/sql-formatter 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @gethue/sql-formatter 可以商用吗？

@gethue/sql-formatter 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gethue/sql-formatter 的下载量有多少？

根据 npm 官方下载统计，@gethue/sql-formatter 在 2026/10/17 – 2026/11/15 这 30 天内被下载 9,951 次，日均约 332 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gethue/sql-formatter 还在维护吗？

最新版本 4\.0\.3 发布于 2021/05/03（5 年前）；至今共发布 1 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/05/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

