Flask-SQLAlchemyアプリで生のSQLを実行する方法

SQLAlchemyで生のSQLをどのように実行しますか？

私はフラスコで実行され、SQLAlchemyを介してデータベースに接続するpython webアプリを持っています。

生のSQLを実行する方法が必要です。クエリには、インラインビューと共に複数のテーブル結合が含まれます。

私はもう試した：

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

しかし、ゲートウェイエラーが発生し続けます。

やってみました：

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

SQL Alchemyセッションオブジェクトには独自のexecuteメソッドがあります。

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

すべてのアプリケーションクエリは、生のSQLかどうかにかかわらず、セッションオブジェクトを経由する必要があります。これにより、クエリがトランザクションによって適切に管理され、同じリクエスト内の複数のクエリを単一のユニットとしてコミットまたはロールバックできるようになります。エンジンまたは接続を使用してトランザクションの外に出ると、微妙なリスクが高まり、データが破損する可能性のあるバグを検出することが困難になる可能性があります。各リクエストは1つのトランザクションにのみ関連付ける必要がdb.sessionあり、これを使用することで、これがアプリケーションに当てはまります。

パラメータ化executeされたクエリ用に設計されていることにも注意してください。:valSQLインジェクション攻撃から身を守るために、クエリへの入力には例のようにパラメータを使用してください。これらのパラメーターの値を指定するにdictは、2番目の引数としてa を渡します。各キーは、クエリに表示されるパラメーターの名前です。パラメータ自体の正確な構文はデータベースによって異なる場合がありますが、すべての主要なリレーショナルデータベースは何らかの形でそれらをサポートしています。

それはだと仮定すると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

個人的には、結果をnamedtuples に変換することを好みます。

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})

docs：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')

SELECT SQLクエリの結果はfrom_statement()、とtext()を使用して取得できます。このようにタプルを扱う必要はありません。あなたが試すことができるUserテーブル名usersを持つクラスの例として、

from sqlalchemy.sql import text
.
.
.
user = session.query(User).from_statement(
    text("SELECT * FROM users where name=:name")).\
    params(name='ed').all()

return user

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

実行し<sql here>ますが、あなたがオンでない限りコミットしませんautocommitモード。そのため、挿入と更新はデータベースに反映されません。

変更後にコミットするには、

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

これは、Flask ShellからSQLクエリを実行する方法の簡単な答えです

まず、モジュールをマッピングします（モジュール/アプリがプリンシパルフォルダーのmanage.pyであり、UNIXオペレーティングシステムを使用している場合）、次のコマンドを実行します。

export FLASK_APP=manage

Flaskシェルを実行する

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

これは、アプリケーションを持つ現在のデータベース接続を使用します。

ドキュメントにconnection.execute(text( <sql here> ), <bind params here> )記載されているパラメータを使用してバインドしましたか？これは、多くのパラメーターのフォーマットとパフォーマンスの問題を解決するのに役立ちます。多分ゲートウェイエラーはタイムアウトですか？バインドパラメータは、複雑なクエリを大幅に高速化する傾向があります。

タプルを避けたい場合は、別の方法としてfirst、oneまたはallメソッドを呼び出します。

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

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