如何在 Flask-SQLAlchemy 应用程序中执行原始 SQL

Question

你如何在 SQLAlchemy 中执行原始 SQL？

我有一个 python web 应用程序，它运行在烧瓶上，并通过 SQLAlchemy 连接到数据库。

我需要一种运行原始 SQL 的方法。 该查询涉及多个表连接以及内联视图。

我试过了：

connection = db.session.connection()
connection.execute( <sql here> )

但我不断收到网关错误。

Answer 1

你有没有尝试过：

result = db.engine.execute("<sql here>")

要么：

from sqlalchemy import text

sql = text('select name from penguins')
result = db.engine.execute(sql)
names = [row[0] for row in result]
print names

请注意， db.engine.execute()是“无连接”， 在 SQLAlchemy 2.0 中已弃用。

Answer 2

SQL Alchemy 会话对象有自己的execute方法：

result = db.session.execute('SELECT * FROM my_table WHERE my_column = :val', {'val': 5})

您的所有应用程序查询都应该通过会话对象，无论它们是否是原始 SQL。 这确保查询由事务正确管理，这允许同一请求中的多个查询作为单个单元提交或回滚。 使用引擎或连接离开事务会使您面临更大的微妙风险，可能难以检测到可能导致数据损坏的错误。 每个请求应该只与一个事务相关联，并且使用db.session将确保您的应用程序是这种情况。

另请注意， execute是为参数化查询设计的。 对查询的任何输入使用参数，如示例中的:val ，以保护自己免受 SQL 注入攻击。 您可以通过将dict作为第二个参数传递来为这些参数提供值，其中每个键是在查询中出现的参数名称。 参数本身的确切语法可能因您的数据库而异，但所有主要关系数据库都以某种形式支持它们。

假设它是一个SELECT查询，这将返回一个可迭代的RowProxy对象。

您可以使用多种技术访问各个列：

for r in result:
    print(r[0]) # Access by positional index
    print(r['my_column']) # Access by column name as a string
    r_dict = dict(r.items()) # convert to dict keyed by column names

就个人而言，我更喜欢将结果转换为namedtuple s：

from collections import namedtuple

Record = namedtuple('Record', result.keys())
records = [Record(*r) for r in result.fetchall()]
for r in records:
    print(r.my_column)
    print(r)

---

如果您没有使用 Flask-SQLAlchemy 扩展，您仍然可以轻松使用会话：

import sqlalchemy
from sqlalchemy.orm import sessionmaker, scoped_session

engine = sqlalchemy.create_engine('my connection string')
Session = scoped_session(sessionmaker(bind=engine))

s = Session()
result = s.execute('SELECT * FROM my_table WHERE my_column = :val', {'val': 5})

Answer 3

文档： SQL 表达式语言教程 - 使用文本

例子：

from sqlalchemy.sql import text

connection = engine.connect()

# recommended
cmd = 'select * from Employees where EmployeeGroup = :group'
employeeGroup = 'Staff'
employees = connection.execute(text(cmd), group = employeeGroup)

# or - wee more difficult to interpret the command
employeeGroup = 'Staff'
employees = connection.execute(
                  text('select * from Employees where EmployeeGroup = :group'), 
                  group = employeeGroup)

# or - notice the requirement to quote 'Staff'
employees = connection.execute(
                  text("select * from Employees where EmployeeGroup = 'Staff'"))


for employee in employees: logger.debug(employee)
# output
(0, 'Tim', 'Gurra', 'Staff', '991-509-9284')
(1, 'Jim', 'Carey', 'Staff', '832-252-1910')
(2, 'Lee', 'Asher', 'Staff', '897-747-1564')
(3, 'Ben', 'Hayes', 'Staff', '584-255-2631')

Answer 4

您可以使用SELECT获得SQL查询的结果from_statement()和text()如图所示这里。 您不必以这种方式处理元组。 作为具有表名users的类User的示例，您可以尝试，

from sqlalchemy.sql import text

user = session.query(User).from_statement(
    text("""SELECT * FROM users where name=:name""")
).params(name="ed").all()

return user

Answer 5

result = db.engine.execute(text("<sql here>"))

执行<sql here>但除非您处于autocommit模式，否则不会提交它。 因此，插入和更新不会反映在数据库中。

要在更改后提交，请执行

result = db.engine.execute(text("<sql here>").execution_options(autocommit=True))

Answer 6

对于 SQLAlchemy ≥ 1.4

从 SQLAlchemy 1.4 开始，不推荐使用无连接或隐式执行，即

db.engine.execute(...) # DEPRECATED

以及作为查询的裸字符串。

新 API 需要显式连接，例如

from sqlalchemy import text

with db.engine.connect() as connection:
    result = connection.execute(text("SELECT * FROM ..."))
    for row in result:
        # ...

同样，如果有可用的会话，则鼓励使用现有会话：

result = session.execute(sqlalchemy.text("SELECT * FROM ..."))

或使用参数：

session.execute(sqlalchemy.text("SELECT * FROM a_table WHERE a_column = :val"),
                {'val': 5})

有关更多详细信息，请参阅文档中的“无连接执行，隐式执行”。

Answer 7

这是如何从 Flask Shell 运行 SQL 查询的简化答案

首先，映射您的模块（如果您的模块/应用程序是主体文件夹中的 manage.py 并且您在 UNIX 操作系统中），运行：

export FLASK_APP=manage

运行烧瓶外壳

flask shell

导入我们需要的东西::

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
db = SQLAlchemy(app)
from sqlalchemy import text

运行您的查询：

result = db.engine.execute(text("<sql here>").execution_options(autocommit=True))

这使用具有应用程序的当前数据库连接。

Answer 8

您是否尝试过使用connection.execute(text( <sql here> ), <bind params here> )和文档中描述的绑定参数？ 这可以帮助解决许多参数格式和性能问题。 也许网关错误是超时？ 绑定参数往往会使复杂查询的执行速度大大加快。

Answer 9

如果您想避免使用元组，另一种方法是调用first 、 one或all方法：

query = db.engine.execute("SELECT * FROM blogs "
                           "WHERE id = 1 ")

assert query.first().name == "Welcome to my blog"