如何解决 SQL Formatter 在 psycopg2 参数格式化中的常见问题

【免费下载链接】sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter

SQL Formatter 是一个强大的 JavaScript SQL 格式化工具，支持多种 SQL 方言，包括 PostgreSQL。但在使用 psycopg2 库时，开发者经常会遇到参数格式化的问题，特别是对于 %s 占位符的处理。本文将为你详细解析这些问题并提供实用的解决方案。😊

📊 psycopg2 参数格式化的核心挑战

psycopg2 是 Python 中最流行的 PostgreSQL 适配器，它使用 %s 作为参数占位符。然而，SQL Formatter 默认并不支持这种占位符类型，这导致了格式化后的 SQL 代码看起来不完整。

问题示例

假设你有这样的 SQL 代码：

SELECT * FROM users WHERE name = %s AND age > %s;

使用默认配置格式化后，结果可能不如预期：

SELECT
  *
FROM
  users
WHERE
  name = % s
  AND age > % s;

🔧 解决方案：使用 paramTypes 配置

SQL Formatter 提供了 paramTypes 配置选项来支持自定义参数占位符语法。

配置步骤

1. 定义自定义参数类型：

format(sql, {
  language: 'postgresql',
  paramTypes: {
    custom: [{
      regex: String.raw`%s`,
    }]
  }
});

完整示例

import { format } from 'sql-formatter';

const sql = "SELECT * FROM users WHERE name = %s AND age > %s";

const result = format(sql, {
  language: 'postgresql',
  paramTypes: {
    custom: [{
      regex: String.raw`%s`,
    }]
  },
  params: ['John', '25']
});

🛠️ 高级配置：参数值替换

如果你希望同时进行参数值替换，可以结合使用 params 选项：

format(sql, {
  language: 'postgresql',
  paramTypes: {
    custom: [{
      regex: String.raw`%s`,
    }]
  },
  params: ['John', '25']
});

配置文件参考

在 src/formatter/Params.ts 中，SQL Formatter 实现了完整的参数处理逻辑，支持各种占位符类型。

📋 常见问题解答

Q: 为什么我的 %s 占位符没有被正确识别？

A: 默认情况下，SQL Formatter 只支持各 SQL 方言的内置占位符语法。你需要通过 paramTypes 显式配置。

Q: 如何支持多种占位符类型？

A: 你可以在 paramTypes 中同时配置多个选项：

paramTypes: {
  positional: true,     // 支持 ? 占位符
  numbered: ['$'],     // 支持 $1, $2 等
  custom: [{
    regex: String.raw`%s`,
  }]
}

🎯 最佳实践

1. 明确指定 SQL 方言：始终设置 language: 'postgresql' 参数
2. 使用 String.raw：避免正则表达式转义问题
3. 测试不同场景：确保格式化结果符合预期

💡 扩展应用

这种方法不仅适用于 psycopg2，还可以用于其他使用非标准占位符的数据库驱动。通过 docs/paramTypes.md 了解更多高级用法。

通过正确配置 SQL Formatter 的 paramTypes 选项，你可以轻松解决 psycopg2 参数格式化的问题，获得美观且功能完整的 SQL 代码。🚀

【免费下载链接】sql-formatter 项目地址: https://gitcode.com/gh_mirrors/sqlf/sql-formatter