SQLAlchemyにおけるdb.session.query()とModel.queryの違い

SQLAlchemyにおける db.session.query() と Model.query の違い

動作

• Model.query: モデルクラス自身に属するクエリプロパティです。
• db.session.query(): 渡されたモデルクラスに基づいてクエリを構築します。

適用範囲

• Model.query: 呼び出すモデルクラスにのみ適用できます。
• db.session.query(): セッションに関連付けられたすべてのモデルクラスに適用できます。

パフォーマンス

• Model.query: 継承関係にあるモデルクラスの場合、パフォーマンスが低下する可能性があります。
• db.session.query(): 多くの場合、Model.query よりも高速です。

使用例

db.session.query()

• セッションスコープでクエリを実行したい場合
• 動的にモデルクラスを指定するクエリ

Model.query

• コードの可読性を向上させたい場合
• 単一のモデルクラスに対する単純なクエリ

from sqlalchemy import create_engine, Column, Integer, String, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship

# エンジンの作成
engine = create_engine("sqlite:///mydb.db")

# セッションの作成
Session = sessionmaker(bind=engine)
session = Session()

# モデルの定義
class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String)

class Address(Base):
    __tablename__ = "addresses"

    id = Column(Integer, primary_key=True)
    user_id = Column(Integer, ForeignKey("users.id"))
    address = Column(String)

# Base.metadata.create_all(engine)

# 1. `db.session.query()` を使用して、すべてのユーザーと関連する住所を取得する

users = db.session.query(User).join(Address).all()

# 2. `User.query` を使用して、名前が "John Doe" のユーザーと関連する住所を取得する

users = User.query.filter(User.name == "John Doe").join(Address).all()

# 3. `Model.query` を使用して、`User` モデルに直接クエリを実行する

users = User.query.filter(User.name.like("%John%"))

# セッションのクローズ
session.close()

sqlalchemy.orm.aliased

sqlalchemy.orm.aliased モジュールを使用すると、モデルクラスのエイリアスを作成できます。これは、同じモデルクラスに対して複数のクエリを実行する場合に便利です。

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.orm import sessionmaker, relationship, aliased

# エンジンの作成
engine = create_engine("sqlite:///mydb.db")

# セッションの作成
Session = sessionmaker(bind=engine)
session = Session()

# モデルの定義
class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String)

# エイリアスの作成
user_alias = aliased(User)

# 複数のクエリを実行
users = session.query(User).filter(User.name == "John Doe").all()
users_alias = session.query(user_alias).filter(user_alias.name == "Jane Doe").all()

# セッションのクローズ
session.close()

sqlalchemy.ext.declarative.BaseQuery

sqlalchemy.ext.declarative.BaseQuery クラスは、Model.query プロパティの基底クラスです。このクラスには、クエリを構築するためのさまざまなメソッドが提供されています。

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.orm import sessionmaker, relationship, aliased

# エンジンの作成
engine = create_engine("sqlite:///mydb.db")

# セッションの作成
Session = sessionmaker(bind=engine)
session = Session()

# モデルの定義
class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String)

# クエリを直接実行
users = session.query(User).filter(User.name.like("%John%")).order_by(User.name.desc()).all()

# セッションのクローズ
session.close()

生SQL

SQLAlchemy は、生の SQL クエリを実行することもできます。これは、複雑なクエリや、ORM で表現できないクエリを実行する場合に便利です。

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.orm import sessionmaker

# エンジンの作成
engine = create_engine("sqlite:///mydb.db")

# セッションの作成
Session = sessionmaker(bind=engine)
session = Session()

# 生SQLクエリを実行
users = session.execute("SELECT * FROM users WHERE name LIKE '%John%' ORDER BY name DESC")

# セッションのクローズ
session.close()