解析 SQL，就用 sqlparse！

文章目录

解析 SQL，就用 sqlparse！
- 一、背景：为什么你需要 sqlparse？
- 二、什么是 sqlparse？
- 三、如何安装 sqlparse？
- 四、简单易用的库函数
- - 1\. `parse(sql)`
  - 2\. `format(sql, **options)`
  - 3\. `split(sql)`
  - 4\. `get_type()`
  - 5\. `flatten()`
- 五、实用场景与代码示例
- - 场景 1：提取表名
  - 场景 2：格式化多条 SQL 语句
  - 场景 3：修改 SQL 语句
  - 场景 4：提取查询字段
  - 场景 5：自定义插件
- 六、常见问题及解决方案
- - 问题

解析 SQL，就用 sqlparse！

一、背景：为什么你需要 sqlparse？

在开发中，SQL 语句的处理常常是一个让人头疼的问题。无论是复杂的查询语句，还是多条 SQL 的批量处理，手动解析和格式化不仅费时费力，还容易出错。而
sqlparse 正是为了解决这些问题而生。它是一个强大的 Python 第三方库，能够帮助开发者轻松解析、格式化和操作 SQL
语句。接下来，我们将深入了解这个库的强大功能。

二、什么是 sqlparse？

sqlparse 是一个非验证性的 SQL 解析器模块，它支持解析、分割和格式化 SQL 语句。它不验证 SQL 的语法是否正确，但可以将 SQL
语句分解为结构化的对象，方便开发者进行进一步的操作。

三、如何安装 sqlparse？

作为第三方库，sqlparse 可以通过 pip 命令轻松安装：

bash复制

pip install sqlparse

安装完成后，你就可以在 Python 代码中导入并使用它。

四、简单易用的库函数

以下是 sqlparse 中常用的五个函数及其使用方法：

1. `parse(sql)`

用于解析 SQL 语句，返回一个包含解析结果的对象列表。

Python复制

import sqlparsesql = "SELECT * FROM users WHERE id = 1;"
parsed = sqlparse.parse(sql)
print(parsed)

sqlparse.parse(sql)：将 SQL 字符串解析为一个对象列表，每个对象代表一条 SQL 语句。

2. `format(sql, **options)`

用于格式化 SQL 语句，使其更易读。

Python复制

sql = "SELECT * FROM users WHERE id = 1;"
formatted_sql = sqlparse.format(sql, reindent=True, keyword_case='upper')
print(formatted_sql)

reindent=True：重新缩进 SQL 语句。
keyword_case='upper'：将关键字转换为大写。

3. `split(sql)`

将包含多条 SQL 语句的字符串分割为单独的语句。

Python复制

multi_sql = "SELECT * FROM users; SELECT * FROM orders;"
statements = sqlparse.split(multi_sql)
print(statements)

sqlparse.split(sql)：将多条 SQL 语句分割为列表。

4. `get_type()`

获取 SQL 语句的类型（如 SELECT、INSERT 等）。

Python复制

parsed = sqlparse.parse(sql)[0]
query_type = parsed.get_type()
print(query_type)

parsed.get_type()：返回当前 SQL 语句的类型。

5. `flatten()`

用于递归解析子组，获取所有 Token。

Python复制

parsed = sqlparse.parse(sql)[0]
for token in parsed.flatten():print(token)

parsed.flatten()：递归解析 SQL 语句中的所有 Token。

五、实用场景与代码示例

以下是 sqlparse 在不同场景中的应用示例：

场景 1：提取表名

Python复制

sql = "SELECT * FROM users WHERE id = 1;"
parsed = sqlparse.parse(sql)[0]
for token in parsed.tokens:if isinstance(token, sqlparse.sql.Identifier):print("表名：", token.get_real_name())

通过 Identifier 类提取 SQL 语句中的表名。

场景 2：格式化多条 SQL 语句

Python复制

multi_sql = "SELECT * FROM users; SELECT * FROM orders;"
statements = sqlparse.split(multi_sql)
for stmt in statements:formatted_sql = sqlparse.format(stmt, reindent=True, keyword_case='upper')print(formatted_sql)

使用 split() 和 format() 方法对多条 SQL 语句进行格式化。

场景 3：修改 SQL 语句

Python复制

sql = "SELECT * FROM users WHERE id = 1;"
parsed = sqlparse.parse(sql)[0]
for token in parsed.tokens:if token.ttype is sqlparse.tokens.Name:token.value = 'customers'
print(parsed)

修改 SQL 语句中的表名。

场景 4：提取查询字段

Python复制

sql = "SELECT name, age FROM users WHERE id = 1;"
parsed = sqlparse.parse(sql)[0]
fields = []
for token in parsed.tokens:if isinstance(token, sqlparse.sql.IdentifierList):for identifier in token.get_identifiers():fields.append(identifier.value)
print("字段列表：", fields)

提取 SELECT 语句中的字段。

场景 5：自定义插件

Python复制

class UppercaseFilter(sqlparse.filters.Filter):def process(self, stream):for token in stream:if token.ttype is sqlparse.tokens.Keyword:token.value = token.value.upper()yield tokensql = "select * from users where id = 1;"
formatted_sql = sqlparse.format(sql, reindent=True, keyword_case='upper', filters=[UppercaseFilter()])
print(formatted_sql)