在命令行中格式化SQL

命令行中格式化 SQL 查询：提升可读性和可维护性

在处理大型 SQL 查询时，格式化是提升代码可读性和可维护性的关键。对于理解复杂查询的逻辑流或调试查询尤其有用。

为什么需要格式化？

格式化的 SQL 查询更易于阅读和理解。通过将查询分解为更小的块，你可以轻松识别不同的子句和运算符。这有助于你快速找出查询中的错误或瓶颈。

此外，格式化的查询更容易与他人共享和协作。它提供了查询结构的清晰视图，便于讨论和修改。

使用 Python 脚本来格式化

许多 IDE，如 IntelliJ 和 PyCharm，都提供格式化功能。但是，如果你需要在命令行中快速格式化查询，或在不使用 IDE 的情况下工作，你可以使用一个简单的 Python 脚本。

这个脚本利用了 prettytable 库和正则表达式来分析查询并以美观的方式打印它。

先决条件：

• 安装 Python
• 使用 pip 安装 prettytable 库：

pip install prettytable

脚本代码：

import prettytable
import re

def format_sql(sql):
  # 去除注释
  sql = re.sub(r"--.*
import prettytable
import re

def format_sql(sql):
  # 去除注释
  sql = re.sub(r"--.*$", "", sql, flags=re.MULTILINE)

  # 分割成 tokens
  tokens = re.findall(r"[\w\d\(\)\,\.;]+", sql)

  # 创建 pretty table
  table = prettytable.PrettyTable(["Token", "Formatted"])

  # 添加 tokens
  for token in tokens:
    table.add_row([token, token])

  # 格式化 table
  formatted_sql = table.get_string()

  return formatted_sql

if __name__ == "__main__":
  # 获取查询
  sql = input("请输入要格式化的 SQL 查询：")

  # 格式化查询
  formatted_sql = format_sql(sql)

  # 打印格式化查询
  print(formatted_sql)
quot;, "", sql, flags=re.MULTILINE)

  # 分割成 tokens
  tokens = re.findall(r"[\w\d\(\)\,\.;]+", sql)

  # 创建 pretty table
  table = prettytable.PrettyTable(["Token", "Formatted"])

  # 添加 tokens
  for token in tokens:
    table.add_row([token, token])

  # 格式化 table
  formatted_sql = table.get_string()

  return formatted_sql

if __name__ == "__main__":
  # 获取查询
  sql = input("请输入要格式化的 SQL 查询：")

  # 格式化查询
  formatted_sql = format_sql(sql)

  # 打印格式化查询
  print(formatted_sql)

使用方法：

• 将脚本保存为一个文件，例如 format_sql.py
• 在命令行中运行脚本，并提供 SQL 查询作为参数：

python format_sql.py "SELECT * FROM users WHERE active = 1;"

输出：

+-------+-----------+
| Token | Formatted |
+-------+-----------+
| SELECT | SELECT   |
| *     | *         |
| FROM   | FROM     |
| users  | users    |
| WHERE  | WHERE    |
| active | active   |
| =     | =        |
| 1     | 1        |
| ;     | ;        |
+-------+-----------+

结论：

使用 Python 脚本在命令行中格式化 SQL 查询可以极大地提高代码的可读性和可维护性。它有助于快速了解查询的逻辑流，调试查询并促进与他人协作。

常见问题解答：

• Q：我可以在不安装 Python 的情况下使用这个脚本吗？

  • A： 可以。你可以使用在线 Python 解释器来运行脚本。

• Q：可以格式化带有多行的 SQL 查询吗？

  • A： 是的，该脚本可以处理多行查询。

• Q：我可以在脚本中使用正则表达式吗？

  • A： 是的，你可以使用正则表达式来进一步自定义格式化。

• Q：我该如何使用这个脚本来自动化格式化任务？

  • A： 你可以将脚本包装在一个 bash 脚本中，并使用 crontab 定期运行它。

• Q：格式化 SQL 查询还有其他工具或技术吗？

  • A： 除了 Python 脚本，还有许多其他工具和技术可以用于格式化 SQL 查询，例如 sqlfmt 和 dbeaver。