SQLAlchemy：打印实际查询

Question

我真的很希望能够为我的应用程序打印出有效的 SQL，包括值，而不是绑定参数，但是在 SQLAlchemy 中如何做到这一点并不明显（按照设计，我很确定）。

有没有人以一般的方式解决了这个问题？

Answer 1

在绝大多数情况下，SQLAlchemy 语句或查询的“字符串化”很简单：

print(str(statement))

这适用于 ORM Query 以及任何 select() 或其他语句。

注意：以下详细答案正在sqlalchemy documentation 上维护。

要将语句编译为特定方言或引擎，如果语句本身尚未绑定到某个语句，您可以将其传递给compile()：

print(statement.compile(someengine))

或者没有引擎：

from sqlalchemy.dialects import postgresql
print(statement.compile(dialect=postgresql.dialect()))

当给定一个 ORM Query 对象时，为了获得 compile() 方法，我们只需要首先访问 .statement 访问器：

statement = query.statement
print(statement.compile(someengine))

关于绑定参数将被“内联”到最终字符串中的原始规定，这里的挑战是 SQLAlchemy 通常不负责此任务，因为这由 Python DBAPI 适当处理，更不用说绕过绑定参数可能是现代 Web 应用程序中利用最广泛的安全漏洞。 SQLAlchemy 在某些情况下（例如发出 DDL）执行此字符串化的能力有限。为了访问此功能，可以使用传递给compile_kwargs 的“literal_binds”标志：

from sqlalchemy.sql import table, column, select

t = table('t', column('x'))

s = select([t]).where(t.c.x == 5)

print(s.compile(compile_kwargs={"literal_binds": True}))

上述方法有一些注意事项，即它仅支持基本的 类型，例如整数和字符串，此外，如果 bindparam 没有预设值直接使用，将无法 将其字符串化。

要支持不支持的类型的内联文字呈现，请实现 TypeDecorator 用于目标类型，其中包括 TypeDecorator.process_literal_param方法：

from sqlalchemy import TypeDecorator, Integer


class MyFancyType(TypeDecorator):
    impl = Integer

    def process_literal_param(self, value, dialect):
        return "my_fancy_formatting(%s)" % value

from sqlalchemy import Table, Column, MetaData

tab = Table('mytable', MetaData(), Column('x', MyFancyType()))

print(
    tab.select().where(tab.c.x > 5).compile(
        compile_kwargs={"literal_binds": True})
)

产生如下输出：

SELECT mytable.x
FROM mytable
WHERE mytable.x > my_fancy_formatting(5)

Answer 2

鉴于您想要的只有在调试时才有意义，您可以使用echo=True 启动 SQLAlchemy，以记录所有 SQL 查询。例如：

engine = create_engine(
    "mysql://scott:tiger@hostname/dbname",
    encoding="latin1",
    echo=True,
)

这也可以针对单个请求进行修改：

echo=False – 如果True，引擎会将所有语句以及参数列表的repr() 记录到引擎记录器，默认为sys.stdout。可以随时修改Engine 的echo 属性来开启和关闭登录。如果设置为字符串"debug"，结果行也将打印到标准输出。这个标志最终控制了一个 Python 记录器；有关如何直接配置日志记录的信息，请参阅 Configuring Logging。

来源：SQLAlchemy Engine Configuration

如果与Flask一起使用，你可以简单地设置

app.config["SQLALCHEMY_ECHO"] = True

获得相同的行为。

Answer 3

这适用于 python 2 和 3，比以前更干净，但需要 SA>=1.0。

from sqlalchemy.engine.default import DefaultDialect
from sqlalchemy.sql.sqltypes import String, DateTime, NullType

# python2/3 compatible.
PY3 = str is not bytes
text = str if PY3 else unicode
int_type = int if PY3 else (int, long)
str_type = str if PY3 else (str, unicode)


class StringLiteral(String):
    """Teach SA how to literalize various things."""
    def literal_processor(self, dialect):
        super_processor = super(StringLiteral, self).literal_processor(dialect)

        def process(value):
            if isinstance(value, int_type):
                return text(value)
            if not isinstance(value, str_type):
                value = text(value)
            result = super_processor(value)
            if isinstance(result, bytes):
                result = result.decode(dialect.encoding)
            return result
        return process


class LiteralDialect(DefaultDialect):
    colspecs = {
        # prevent various encoding explosions
        String: StringLiteral,
        # teach SA about how to literalize a datetime
        DateTime: StringLiteral,
        # don't format py2 long integers to NULL
        NullType: StringLiteral,
    }


def literalquery(statement):
    """NOTE: This is entirely insecure. DO NOT execute the resulting strings."""
    import sqlalchemy.orm
    if isinstance(statement, sqlalchemy.orm.Query):
        statement = statement.statement
    return statement.compile(
        dialect=LiteralDialect(),
        compile_kwargs={'literal_binds': True},
    ).string

演示：

# coding: UTF-8
from datetime import datetime
from decimal import Decimal

from literalquery import literalquery


def test():
    from sqlalchemy.sql import table, column, select

    mytable = table('mytable', column('mycol'))
    values = (
        5,
        u'snowman: ☃',
        b'UTF-8 snowman: \xe2\x98\x83',
        datetime.now(),
        Decimal('3.14159'),
        10 ** 20,  # a long integer
    )

    statement = select([mytable]).where(mytable.c.mycol.in_(values)).limit(1)
    print(literalquery(statement))


if __name__ == '__main__':
    test()

给出这个输出：（在 python 2.7 和 3.4 中测试）

SELECT mytable.mycol
FROM mytable
WHERE mytable.mycol IN (5, 'snowman: ☃', 'UTF-8 snowman: ☃',
      '2015-06-24 18:09:29.042517', 3.14159, 100000000000000000000)
 LIMIT 1

Answer 4

为此，我们可以使用compile 方法。来自docs：

from sqlalchemy.sql import text
from sqlalchemy.dialects import postgresql

stmt = text("SELECT * FROM users WHERE users.name BETWEEN :x AND :y")
stmt = stmt.bindparams(x="m", y="z")

print(stmt.compile(dialect=postgresql.dialect(),compile_kwargs={"literal_binds": True}))

结果：

SELECT * FROM users WHERE users.name BETWEEN 'm' AND 'z'

来自文档的警告：

切勿对从不受信任的字符串内容使用此技术 输入，例如来自 Web 表单或其他用户输入应用程序。 SQLAlchemy 将 Python 值强制转换为直接 SQL 字符串的工具 值对于不受信任的输入是不安全的，并且不验证 传递的数据类型。始终使用绑定参数 以编程方式针对关系调用非 DDL SQL 语句 数据库。

Answer 5

因此，基于@bukzor 代码上的@zzzeek 的cmets，我想出了这个来轻松获得“可打印”的查询：

def prettyprintable(statement, dialect=None, reindent=True):
    """Generate an SQL expression string with bound parameters rendered inline
    for the given SQLAlchemy statement. The function can also receive a
    `sqlalchemy.orm.Query` object instead of statement.
    can 

    WARNING: Should only be used for debugging. Inlining parameters is not
             safe when handling user created data.
    """
    import sqlparse
    import sqlalchemy.orm
    if isinstance(statement, sqlalchemy.orm.Query):
        if dialect is None:
            dialect = statement.session.get_bind().dialect
        statement = statement.statement
    compiled = statement.compile(dialect=dialect,
                                 compile_kwargs={'literal_binds': True})
    return sqlparse.format(str(compiled), reindent=reindent)

我个人很难阅读没有缩进的代码，所以我使用sqlparse 重新缩进 SQL。可以用pip install sqlparse安装。

Answer 6

此代码基于来自@bukzor 的出色existing answer。我刚刚将datetime.datetime 类型的自定义渲染添加到Oracle 的TO_DATE() 中。

随时更新代码以适应您的数据库：

import decimal
import datetime

def printquery(statement, bind=None):
    """
    print a query, with values filled in
    for debugging purposes *only*
    for security, you should always separate queries from their values
    please also note that this function is quite slow
    """
    import sqlalchemy.orm
    if isinstance(statement, sqlalchemy.orm.Query):
        if bind is None:
            bind = statement.session.get_bind(
                    statement._mapper_zero_or_none()
            )
        statement = statement.statement
    elif bind is None:
        bind = statement.bind 

    dialect = bind.dialect
    compiler = statement._compiler(dialect)
    class LiteralCompiler(compiler.__class__):
        def visit_bindparam(
                self, bindparam, within_columns_clause=False, 
                literal_binds=False, **kwargs
        ):
            return super(LiteralCompiler, self).render_literal_bindparam(
                    bindparam, within_columns_clause=within_columns_clause,
                    literal_binds=literal_binds, **kwargs
            )
        def render_literal_value(self, value, type_):
            """Render the value of a bind parameter as a quoted literal.

            This is used for statement sections that do not accept bind paramters
            on the target driver/database.

            This should be implemented by subclasses using the quoting services
            of the DBAPI.

            """
            if isinstance(value, basestring):
                value = value.replace("'", "''")
                return "'%s'" % value
            elif value is None:
                return "NULL"
            elif isinstance(value, (float, int, long)):
                return repr(value)
            elif isinstance(value, decimal.Decimal):
                return str(value)
            elif isinstance(value, datetime.datetime):
                return "TO_DATE('%s','YYYY-MM-DD HH24:MI:SS')" % value.strftime("%Y-%m-%d %H:%M:%S")

            else:
                raise NotImplementedError(
                            "Don't know how to literal-quote value %r" % value)            

    compiler = LiteralCompiler(dialect, statement)
    print compiler.process(statement)

Answer 7

我想指出，上面给出的解决方案不能“仅适用于”非平凡的查询。我遇到的一个问题是更复杂的类型，例如导致问题的 pgsql 数组。我确实找到了一个解决方案，对我来说，即使使用 pgsql ARRAYs 也能正常工作：

借自： https://gist.github.com/gsakkis/4572159

链接的代码似乎基于旧版本的 SQLAlchemy。您将收到一条错误消息，指出属性 _mapper_zero_or_none 不存在。这是一个适用于较新版本的更新版本，您只需将 _mapper_zero_or_none 替换为 bind。此外，它还支持 pgsql 数组：

# adapted from:
# https://gist.github.com/gsakkis/4572159
from datetime import date, timedelta
from datetime import datetime

from sqlalchemy.orm import Query


try:
    basestring
except NameError:
    basestring = str


def render_query(statement, dialect=None):
    """
    Generate an SQL expression string with bound parameters rendered inline
    for the given SQLAlchemy statement.
    WARNING: This method of escaping is insecure, incomplete, and for debugging
    purposes only. Executing SQL statements with inline-rendered user values is
    extremely insecure.
    Based on http://stackoverflow.com/questions/5631078/sqlalchemy-print-the-actual-query
    """
    if isinstance(statement, Query):
        if dialect is None:
            dialect = statement.session.bind.dialect
        statement = statement.statement
    elif dialect is None:
        dialect = statement.bind.dialect

    class LiteralCompiler(dialect.statement_compiler):

        def visit_bindparam(self, bindparam, within_columns_clause=False,
                            literal_binds=False, **kwargs):
            return self.render_literal_value(bindparam.value, bindparam.type)

        def render_array_value(self, val, item_type):
            if isinstance(val, list):
                return "{%s}" % ",".join([self.render_array_value(x, item_type) for x in val])
            return self.render_literal_value(val, item_type)

        def render_literal_value(self, value, type_):
            if isinstance(value, long):
                return str(value)
            elif isinstance(value, (basestring, date, datetime, timedelta)):
                return "'%s'" % str(value).replace("'", "''")
            elif isinstance(value, list):
                return "'{%s}'" % (",".join([self.render_array_value(x, type_.item_type) for x in value]))
            return super(LiteralCompiler, self).render_literal_value(value, type_)

    return LiteralCompiler(dialect, statement).process(statement)

测试了两层嵌套数组。

Answer 8

只是一个简单的带有 ORM 查询和 pygments 的彩色示例。

import sqlparse
from pygments import highlight
from pygments.formatters.terminal import TerminalFormatter
from pygments.lexers import SqlLexer
from sqlalchemy import create_engine
from sqlalchemy.orm import Query

engine = create_engine("sqlite+pysqlite:///db.sqlite", echo=True, future=True)

def format_sql(query: Query):
    compiled = query.statement.compile(
         engine, compile_kwargs={"literal_binds": True})
    parsed = sqlparse.format(str(compiled), reindent=True, keyword_case='upper')
    print(highlight(parsed, SqlLexer(), TerminalFormatter()))

或不带sqlparse的版本（不带sqlparse的输出新行少）

def format_sql(query: Query):
    compiled = query.statement.compile(
        engine, compile_kwargs={"literal_binds": True})
    print(highlight(str(compiled), SqlLexer(), TerminalFormatter()))

Answer 9

使用 Python 日志记录而不是 echo=True 标志来记录 SQL 查询：

import logging

logging.basicConfig()
logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)

根据documentation。