使用sqlparse解析CASE WHEN语句

Question

我有以下SQL查询，并想使用解析 sqlparse

import sqlparse

query =  """
select SUM(case when(A.dt_unix<=86400
                     and B.flag="V") then 1
           end) as TEST_COLUMN_1,
       SUM(case when(A.Amt - B.Amt > 0
                     and B.Cat1 = "A"
                     and (B.Cat2 = "M"
                          or B.Cat3 = "C"
                          or B.Cat4 = "B")
                     and B.Cat5 is NULL) then 1
           end) as TEST_COLUMN_2
from test_table A
left join test_table_2 as B on A.ID=B.ID
where A.DT >B.DT
group by A.ID
"""

query_tokens = sqlparse.parse(query)[0].tokens
print(query_tokens)

将给出SQL语句中包含的所有令牌：

[<Newline ' ' at 0x7FAA62BD9F48>, <DML 'select' at 0x7FAA62BE7288>, <Whitespace ' ' at 0x7FAA62BE72E8>, <IdentifierList 'SUM(ca...' at 0x7FAA62BF7CF0>, <Newline ' ' at 0x7FAA62BF6288>, <Keyword 'from' at 0x7FAA62BF62E8>, <Whitespace ' ' at 0x7FAA62BF6348>, <Identifier 'test_t...' at 0x7FAA62BF7570>, <Newline ' ' at 0x7FAA62BF64C8>, <Keyword 'left j...' at 0x7FAA62BF6528>, <Whitespace ' ' at 0x7FAA62BF6588>, <Identifier 'test_t...' at 0x7FAA62BF7660>, <Whitespace ' ' at 0x7FAA62BF67C8>, <Keyword 'on' at 0x7FAA62BF6828>, <Whitespace ' ' at 0x7FAA62BF6888>, <Comparison 'A.ID=B...' at 0x7FAA62BF7B10>, <Newline ' ' at 0x7FAA62BF6B88>, <Where 'where ...' at 0x7FAA62BF28B8>, <Keyword 'group' at 0x7FAA62BD9E88>, <Whitespace ' ' at 0x7FAA62BD93A8>, <Keyword 'by' at 0x7FAA62BD9EE8>, <Whitespace ' ' at 0x7FAA62C1CEE8>, <Identifier 'A.ID' at 0x7FAA62BF2F48>, <Newline ' ' at 0x7FAA62BF6C48>]

我如何解析这些标记，以便以CASE WHEN一种可以提取所有条件并保持其优先级的方式处理语句，如使用括号所定义的那样。我在文档中找不到任何相关示例。

有什么想法吗？

Answer 1

该项目确实的文档不足。我看了看这些示例，然后稍微扫描了一下源代码。遗憾的是，该文档并未包含Token和TokenList类上可用于此任务的所有方法。

例如，method是一个重要但被省略的TokenList.get_sublists()方法，它使您比其他方法更容易遍历嵌套的令牌列表。该TokenList.flatten()方法仅在树中产生未分组的令牌，而是CASE分组的令牌，因此单凭文档来看，您可能会发现很难对解析的令牌树进行有用的操作。

我在代码库中注意到的另一个方便的方法是TokenList._pprint_tree()method，该方法将当前令牌树转储到stdout。尝试编写分析树的代码时，这非常有用。

总的来说sqlparse，它不是解析库，而是重新格式化SQL的工具。它包括一个很好的解析器，但不包括一般使用它生成的树所必需的工具。

库中真正缺少的是基节点访问者类（例如Python ast模块提供的类）或树节点遍历器，再次类似于该ast模块提供的。幸运的是，这两种方法都很容易构建：

from collections import deque
from sqlparse.sql import TokenList

class SQLTokenVisitor:
    def visit(self, token):
        """Visit a token."""
        method = 'visit_' + type(token).__name__
        visitor = getattr(self, method, self.generic_visit)
        return visitor(token)

    def generic_visit(self, token):
        """Called if no explicit visitor function exists for a node."""
        if not isinstance(token, TokenList):
            return
        for tok in token:
            self.visit(tok)

def walk_tokens(token):
    queue = deque([token])
    while queue:
        token = queue.popleft()
        if isinstance(token, TokenList):
            queue.extend(token)
        yield token

现在，您可以使用其中之一来访问Case节点：

statement, = sqlparse.parse(query)

class CaseVisitor(SQLTokenVisitor):
    """Build a list of SQL Case nodes

      The .cases list is a list of (condition, value) tuples per CASE statement

    """
    def __init__(self):
        self.cases = []

    def visit_Case(self, token):
        branches = []
        for when, then_ in token.get_cases():
            branches
        self.cases.append(token.get_cases())

visitor = CaseVisitor()
visitor.visit(statement)
cases = visitor.cases

要么

statement, = sqlparse.parse(query)

cases = []
for token in walk_tokens(statement):
    if isinstance(token, sqlparse.sql.Case):
        cases.append(token.get_cases())

在此示例中，walk_tokens()和NodeVisitor模式之间的差异可以忽略不计，但是我们只是为每个CASE语句提取了分离的标记，而没有处理WHEN ... THEN ...标记。在此NodeVisitor模式中，您将在当前访问者实例上设置更多属性以“切换齿轮”，并以更多visit_....方法捕获有关那些子树令牌的更多信息，这可能比for生成器上的嵌套循环更容易理解。

另一方面，使用walk_tokens()生成器时，如果创建一个单独的变量来引用生成器，则可以将迭代移交给辅助函数：

all_tokens = walk_tokens(stamement)
for token in walk_tokens(statement):
    if isinstance(token, sqlparse.sql.Case):
        branches = extract_branches(all_tokens)

在extract_branches案件陈述的结尾处将进一步迭代。