解析 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)

• 使用自定義插件將關鍵字轉換為大寫。

六、常見問題及解決方案

以下是使用 sqlparse 時常見的三個問題及解決方法：

問題

如果你覺得文章還不錯，請大家 點贊、分享、留言 下，因為這將是我持續輸出更多優質文章的最強動力！