SQL Formatter 安装与配置完全指南

SQL Formatter 安装与配置完全指南

sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter

项目基础介绍及主要编程语言

SQL Formatter 是一个JavaScript库，专为各种查询语言提供空白格式化功能。它起源于PHP库的一个端口，但已发展出许多差异性功能。该工具支持包括MySQL、PostgreSQL、Oracle PL/SQL在内的多种SQL方言，并且通过简单的API或命令行界面即可轻松格式化SQL查询。项目采用MIT许可证进行分发。

主要编程语言: JavaScript

关键技术和框架

• 核心库: 使用JavaScript编写，适用于Node.js环境以及前端项目。
• 依赖管理: 通过npm（Node Package Manager）来处理项目依赖。
• 可选集成: 提供CLI工具，方便命令行下直接使用。

安装和配置步骤

准备工作

确保你的系统已经安装了Node.js。你可以从官方网站下载并安装Node.js。安装完成后，你会拥有npm，这是Node.js的包管理器。

详细安装步骤

安装作为开发依赖

如果你是在一个项目中使用SQL Formatter作为开发工具：

npm install --save-dev sql-formatter

或者，如果你偏好使用Yarn：

yarn add --dev sql-formatter

简单使用示例

在你的JavaScript文件中引入并使用SQL Formatter：

const { format } = require('sql-formatter');
console.log(format("SELECT * FROM table_name", { language: 'mysql' }));

全局安装与命令行使用

若要全局安装以便任何地方都能快速使用命令行工具：

npm install -g sql-formatter

然后你可以直接格式化SQL文件：

sql-formatter -f your_sql_file.sql

这里的 -f 参数指定需要格式化的SQL文件路径。

配置选项

在代码中使用时，可以通过传递对象给 format 方法来自定义格式化设置，例如调整关键字大小写、缩进宽度等：

const formattedSql = format(
    "SELECT * FROM Users",
    {
        language: "mysql",
        tabWidth: 4,
        keywordCase: "upper",
    }
);

对于命令行工具，可以通过 -c 或 --config 参数指定JSON配置文件路径或直接提供JSON字符串来进行配置。

示例配置文件

创建一个名为 sql-formatter.json 的配置文件，内容如下：

{
    "language": "postgres",
    "tabWidth": 2,
    "keywordCase": "upper"
}

然后运行命令：

sql-formatter -c path/to/your/sql-formatter.json -f your_query.sql

至此，您已成功安装并配置了SQL Formatter，无论是通过脚本直接调用还是利用命令行工具，都可便捷地对SQL查询进行美化和格式化。

sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter