flask データベース処理（Flask-SqLAlchemy）

2023年03月08日

2023年03月04日

flaskでデータベースにアクセスするには
Flask-SQLAlchemy
Flask-SQLAlchemyとは？
ドキュメント（3.0x）
PyPi
⚠注意点
SELECT
INSERT
UPDATE
DELETE

flaskでデータベースにアクセスするには

データベースを用意して、flask ⇔ データベースの接続、SQL文を記述して実行 → Commit

せっかくフレームワークを使用して共通性を持たせているのであれば、なるべくデータベース関連も同じく共通化しておきたい。
※他の人が触ってもわかりやすくしておき、保守・メンテナンス性を高める目的。

pythonはいろいろなパッケージが既に用意されています。

データベース関連では【SQLAlchemy】

SQLAlchemy（ウィキペディア）
SQLAlchemyは、Pythonプログラミング言語のためのオープンソースのSQLツールキットおよびオブジェクト関係マッピングライブラリ（ORM）で、MIT Licenseの下で公開されている。

SQL文を直接かかなくても、関数を使用してデータベースの値を取得・創成・更新・削除できる。

Flask-SQLAlchemy

Flask-SQLAlchemyとは？

Flask-SQLAlchemy
Flask-SQLAlchemy is an extension for Flask that adds support for SQLAlchemy to your application. It simplifies using SQLAlchemy with Flask by setting up common objects and patterns for using those objects, such as a session tied to each web request, models, and engines.
Flask-SQLAlchemy does not change how SQLAlchemy works or is used.
—訳—：
Flask-SQLAlchemy は、アプリケーションにSQLAlchemyのサポートを追加するFlaskの拡張機能です。各 Web リクエスト、モデル、エンジンに関連付けられたセッションなど、共通のオブジェクトとそれらのオブジェクトを使用するためのパターンを設定することで、Flask での SQLAlchemy の使用を簡素化します。
Flask-SQLAlchemy は、SQLAlchemy の動作方法や使用方法を変更しません。

FlaskでSQLAlchemyを簡単に使用できるようにしている

ドキュメント（3.0x）

https://flask-sqlalchemy.palletsprojects.com/en/3.0.x/

PyPi

2023年03月時点：version 3.0.3

https://pypi.org/project/Flask-SQLAlchemy/

⚠注意点

"Model.query" や "session.query”の記述はレガシーの為、推奨の方法を当サイトは記載しております。

Legacy Query Interface
You may see uses of Model.query or session.query to build queries. That query interface is considered legacy in SQLAlchemy. Prefer using the session.execute(select(...)) instead.
—訳—：
Model.queryまたはを使用してクエリを作成する場合がありますsession.query。そのクエリインターフェイスは、SQLAlchemy ではレガシーと見なされます。代わりにを使用することをお勧めします session.execute(select(...))。