求DBeaver中安装外部格式化工具pg-formatter的详细步骤

工具说明 #

有两个主流的pg-formatter工具可选：

• gajus/pg-formatter：基于Node.js开发的SQL格式化工具，安装依赖Node.js环境
• darold/pgFormatter：基于Perl开发的SQL格式化工具，安装依赖Perl环境

以下分系统提供详细安装步骤：

Windows系统安装步骤 #

安装gajus/pg-formatter（Node.js版） #

1. 安装Node.js
   • 下载Node.js长期支持（LTS）版安装包，双击运行并按默认选项完成安装
   • 验证安装：按下Win+R输入cmd打开命令提示符，执行node -v和npm -v，能显示版本号即为成功
2. 安装pg-formatter
   • 在命令提示符中执行：npm install -g pg-formatter
   • 验证安装：执行pg-formatter --version，显示版本号即为成功

安装darold/pgFormatter（Perl版） #

1. 检查Perl环境
   • 打开命令提示符，执行perl -v，若显示版本信息则跳过下一步；若未安装则继续
2. 安装Perl
   • 下载Strawberry Perl的Windows安装包，双击运行默认安装
   • 验证安装：重启命令提示符，执行perl -v确认版本
3. 安装pgFormatter
   • 执行cpan App::cpanminus安装包管理器
   • 执行cpanm pgFormatter完成工具安装
   • 验证安装：执行pg_format --version，显示版本号即为成功

macOS系统安装步骤 #

安装gajus/pg-formatter（Node.js版） #

1. 安装Node.js
   • 打开终端，若已安装Homebrew，执行brew install node；未安装则下载Node.js LTS版安装包手动安装
   • 验证安装：执行node -v和npm -v确认
2. 安装pg-formatter
   • 执行npm install -g pg-formatter
   • 验证安装：执行pg-formatter --version

安装darold/pgFormatter（Perl版） #

1. macOS自带Perl，先验证：终端执行perl -v确认环境
2. 安装cpanm包管理器：执行curl -L https://cpanmin.us | perl - --sudo App::cpanminus
3. 安装pgFormatter：执行sudo cpanm pgFormatter，输入系统密码后等待安装完成
4. 验证安装：执行pg_format --version

Linux系统（Ubuntu/Debian为例） #

安装gajus/pg-formatter（Node.js版） #

1. 安装Node.js
   • 终端执行sudo apt update && sudo apt install nodejs npm
   • 验证安装：执行node -v和npm -v
2. 安装pg-formatter
   • 执行sudo npm install -g pg-formatter
   • 验证安装：执行pg-formatter --version

安装darold/pgFormatter（Perl版） #

1. 安装依赖：执行sudo apt update && sudo apt install perl cpanminus
2. 安装pgFormatter：执行sudo cpanm pgFormatter
3. 验证安装：执行pg_format --version

DBeaver配置步骤 #

1. 打开DBeaver，点击顶部菜单「编辑」→「首选项」
2. 在左侧导航栏依次展开「SQL编辑器」→「格式化」
3. 选择「自定义格式化工具」，点击「添加」按钮
4. 配置工具信息：
   • 工具名称：自定义（如pg-formatter）
   • 命令行：填入对应工具的命令
     • gajus版：pg-formatter
     • darold版：pg_format
   • 参数（可选）：根据需求添加，例如darold版用-s 2设置2空格缩进，gajus版用--indent 2
5. 点击「测试」，输入一段SQL代码，若能正常格式化则配置成功，最后点击「应用」「确定」

内容的提问来源于stack exchange，提问作者Reyesnes