调试SQLAlchemy发送到数据库的SQL命令

151 投票
2 回答
144125 浏览
提问于 2025-04-15 23:24

我有一个叫做 Person 的 ORM 类,它是用来操作一个关于人的表的:

在我设置好数据库连接等之后,我运行了以下代码:

people = session.query(Person).all()

这个人表现在还没有任何数据,所以当我打印变量 people 的时候,得到的是一个空列表。

我把 ORM 类中提到的表名从 People 改成了 people_foo(这个表并不存在)。

然后我再次运行脚本。让我惊讶的是,当我试图访问一个不存在的表时,并没有抛出任何异常。

因此,我有以下两个问题:

  1. 我该如何设置 SQLAlchemy,以便它能把数据库错误反馈到脚本中?
  2. 我该如何查看(也就是打印)发送给数据库引擎的 SQL 语句?

如果有帮助的话,我使用的是 PostgreSQL。

[编辑]

我正在写一个包。在我的 __main__.py 脚本中,有以下代码(这里简化了):

### __main__.py
import common # imports logging and defines logging setup funcs etc

logger = logging.getLogger(__name__)


def main():    
    parser = OptionParser(usage="%prog [options] <commands>",
                          version="%prog 1.0")

    commands = OptionGroup(parser, "commands")

    parser.add_option(
        "-l",
        "--logfile",
        dest="logfile",
        metavar="FILE",
        help="log to FILE. if not set, no logging will be done"
    )

    parser.add_option(
        "--level",
        dest="loglevel",
        metavar="LOG LEVEL",
        help="Debug level. if not set, level will default to low"
    )

    # Set defaults if not specified
    if not options.loglevel:
        loglevel = 1
    else:
        loglevel = options.loglevel

    if not options.logfile:
        logfilename = 'datafeed.log'
    else:
        logfilename = options.logfile

    common.setup_logger(False, logfilename, loglevel) 

       # and so on ...



        #### dbfuncs.py


import logging

    # not sure how to 'bind' to the logger in __main__.py
    logging.getLogger('sqlalchemy.engine').setLevel(logging.INFO)

    engine = create_engine('postgres://postgres:pwd@localhost:port/dbname', echo=True)

[编辑2]

公共模块正确设置了日志记录器,我可以在其他导入公共模块的模块中使用这个日志记录器。

但是在 dbfuncs 模块中,我遇到了以下错误/警告:

找不到 "sqlalchemy.engine.base.Engine" 的处理程序

2 个回答

144

你可以通过在创建数据库引擎实例时加上 echo=True 来查看发送到数据库的SQL语句(通常是在你的代码中使用 create_engine()engine_from_config() 来创建)。

比如说:

engine = sqlalchemy.create_engine('postgres://foo/bar', echo=True)

默认情况下,记录的语句会输出到标准输出(也就是控制台)。

306

除了在 create_engine() 函数中使用 echo 参数,还有一种更灵活的方法:就是通过配置 logging 来显示引擎的语句。

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

想了解更多信息,可以查看文档中的 配置日志 部分。

撰写回答