FastAPI + SQLAlchemy でテーブルリレーションの実装まとめ（多対多）

2024-04-02

SQLAlchemyにおける多対多関係（中間テーブルを用いた場合）

SQLAlchemyでは、多対多関係を表現する際に中間テーブルを用いる方法があります。これは、2つのテーブル間で直接的な関係を定義するのではなく、中間テーブルを介して間接的に関係を定義する方法です。

メリット

より柔軟なデータモデル設計が可能
複雑な関係を表現できる
エンティティ間の関係をより詳細に制御できる

データモデルが複雑になる
クエリが複雑になる

コード例

from sqlalchemy import Column, Integer, String, ForeignKey, Table

# 中間テーブル
association_table = Table(
    'association_table',
    Base.metadata,
    Column('left_id', Integer, ForeignKey('left_table.id')),
    Column('right_id', Integer, ForeignKey('right_table.id')),
)

# 左側のテーブル
class LeftTable(Base):
    __tablename__ = 'left_table'

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

    # 中間テーブルとの関連付け
    right_tables = relationship('RightTable', secondary=association_table)

# 右側のテーブル
class RightTable(Base):
    __tablename__ = 'right_table'

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

    # 中間テーブルとの関連付け
    left_tables = relationship('LeftTable', secondary=association_table)

解説

association_table は中間テーブルです。
LeftTable と RightTable は多対多関係で関連付けられています。
relationship デコレータを使用して、関連付けを定義しています。
secondary パラメータで、中間テーブルを指定しています。

クエリ例

# 左側のテーブルから、関連付けられているすべての右側のテーブルを取得
left_table = session.query(LeftTable).get(1)
right_tables = left_table.right_tables

# 右側のテーブルから、関連付けられているすべての左側のテーブルを取得
right_table = session.query(RightTable).get(1)
left_tables = right_table.left_tables

中間テーブルには、追加の属性を定義することができます。
中間テーブルを使用して、多対多関係をさらに複雑な方法で表現することができます。

注意

中間テーブルを用いた多対多関係は、複雑なデータモデルを設計する場合にのみ使用する必要があります。
中間テーブルを用いると、データモデルとクエリが複雑になるため、注意が必要です。

from sqlalchemy import Column, Integer, String, ForeignKey, Table, create_engine

# 中間テーブル
association_table = Table(
    'association_table',
    Base.metadata,
    Column('left_id', Integer, ForeignKey('left_table.id')),
    Column('right_id', Integer, ForeignKey('right_table.id')),
)

# 左側のテーブル
class LeftTable(Base):
    __tablename__ = 'left_table'

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

    # 中間テーブルとの関連付け
    right_tables = relationship('RightTable', secondary=association_table)

# 右側のテーブル
class RightTable(Base):
    __tablename__ = 'right_table'

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

    # 中間テーブルとの関連付け
    left_tables = relationship('LeftTable', secondary=association_table)

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

# テーブルの作成
Base.metadata.create_all(engine)

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

# データの挿入
left_table1 = LeftTable(name='left_table1')
left_table2 = LeftTable(name='left_table2')
right_table1 = RightTable(name='right_table1')
right_table2 = RightTable(name='right_table2')

left_table1.right_tables.append(right_table1)
left_table1.right_tables.append(right_table2)
left_table2.right_tables.append(right_table1)

session.add_all([left_table1, left_table2, right_table1, right_table2])
session.commit()

# クエリ
# 左側のテーブルから、関連付けられているすべての右側のテーブルを取得
left_table = session.query(LeftTable).get(1)
right_tables = left_table.right_tables

# 右側のテーブルから、関連付けられているすべての左側のテーブルを取得
right_table = session.query(RightTable).get(1)
left_tables = right_table.left_tables

# 結果の出力
for right_table in right_tables:
    print(right_table.name)

for left_table in left_tables:
    print(left_table.name)

実行結果

right_table1
right_table2
left_table1
left_table2

説明

このコードは、SQLiteデータベースを使用しています。
Base は、SQLAlchemyの declarative_base クラスから継承したクラスです。
Column は、テーブルのカラムを定義するために使用されます。
ForeignKey は、外部キー制約を定義するために使用されます。
relationship は、関連付けを定義するために使用されます。
create_engine は、データベースエンジンを作成するために使用されます。
Base.metadata.create_all は、テーブルを作成するために使用されます。
Session は、データベースとのセッションを表します。
add_all は、複数のオブジェクトをデータベースに追加するために使用されます。
commit は、データベースへの変更をコミットするために使用されます。
query は、クエリを実行するために使用されます。
get は、主キーでオブジェクトを取得するために使用されます。

補足

実際のアプリケーションでは、必要に応じてコードを変更する必要があります。

SQLAlchemyにおける多対多関係の表現方法

中間テーブルを用いた方法

外部キー制約を用いた方法

中間テーブルを使用せずに、2つのテーブルの間に直接的な外部キー制約を定義することで多対多関係を表現することができます。この方法は、比較的シンプルですが、柔軟性に欠けます。

from sqlalchemy import Column, Integer, String, ForeignKey

# 左側のテーブル
class LeftTable(Base):
    __tablename__ = 'left_table'

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

    # 右側のテーブルへの外部キー
    right_table_id = Column(Integer, ForeignKey('right_table.id'))

# 右側のテーブル
class RightTable(Base):
    __tablename__ = 'right_table'

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

この方法では、LeftTable テーブルの right_table_id カラムが、RightTable テーブルの id カラムを参照しています。

サブクエリを用いた方法

中間テーブルや外部キー制約を使用せずに、サブクエリを用いて多対多関係を表現することができます。この方法は、最も複雑な方法であり、パフォーマンスの問題が発生する可能性があります。

from sqlalchemy import Column, Integer, String, ForeignKey, subqueryload

# 左側のテーブル
class LeftTable(Base):
    __tablename__ = 'left_table'

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

# 右側のテーブル
class RightTable(Base):
    __tablename__ = 'right_table'

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

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

# サブクエリを用いて、関連付けられているすべての右側のテーブルを取得
left_table = session.query(LeftTable).options(subqueryload(LeftTable.right_tables)).get(1)
right_tables = left_table.right_tables

この方法では、subqueryload オプションを使用して、LeftTable オブジェクトを取得する際に、関連付けられているすべての RightTable オブジェクトも同時に取得しています。

どの方法を使用するかは、データモデルの複雑性やパフォーマンス要件によって異なります。

柔軟性と拡張性を重視する場合は、中間テーブルを用いた方法を使用します。
パフォーマンスが重要な場合は、中間テーブルを用いた方法または外部キー制約を用いた方法を使用します。

sqlalchemy