エンティティが自分自身と繋がる？SQLAlchemyにおける多対多自己参照関係のしくみ

2024-07-27

SQLAlchemyにおける多対多自己参照関係

この関係は、ソーシャルネットワークサイトなど、ユーザーが互いをフォローできるようなシステムでよく見られます。例えば、ユーザーAがユーザーBをフォローしている場合、これはユーザーAとユーザーBの間の多対多自己参照関係を表します。

SQLAlchemyで多対多自己参照関係を実装するには、以下の手順が必要です。

中間テーブルを作成する: 2つのエンティティ間の関係を保存するためのテーブルを作成します。このテーブルには、各エンティティへの外部キーと、追加の属性 (関係の重みなど) を含めることができます。
関係を定義する: 各エンティティクラスで、manytomany()デコレータを使用して中間テーブルとの関係を定義します。secondary引数を使用して中間テーブルを指定し、primary_key引数を使用して中間テーブルの主キー列を指定します。
バックリファレンスを設定する (オプション): 各エンティティクラスで、backref引数を使用して反対側の方向の関係を定義できます。これは、各エンティティインスタンスが関連付けられている関連エンティティインスタンスのリストにアクセスできるようにします。

以下は、SQLAlchemyで多対多自己参照関係を実装する例です。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String

engine = create_engine("sqlite:///example.db")
Base = declarative_base()

class User(Base):
    __tablename__ = "users"

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

    followers = relationship("User",
                           secondary="followers_table",
                           backref="following")

class FollowersTable(Base):
    __tablename__ = "followers_table"

    follower_id = Column(Integer, ForeignKey("users.id"), primary_key=True)
    followed_id = Column(Integer, ForeignKey("users.id"), primary_key=True)

Base.metadata.create_all(engine)

この例では、Userエンティティはそれ自身と多対多自己参照関係を持っています。followers_tableという中間テーブルが作成され、ユーザーがフォローしているユーザーを保存します。

各Userインスタンスには、followers属性があります。この属性は、そのユーザーをフォローしているすべてのユーザーのリストを返します。同様に、各Userインスタンスには、following属性があります。この属性は、そのユーザーがフォローしているすべてのユーザーのリストを返します。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String, Text

engine = create_engine("sqlite:///articles.db")
Base = declarative_base()


class Article(Base):
    __tablename__ = "articles"

    id = Column(Integer, primary_key=True)
    title = Column(String(255))
    content = Column(Text)


class ArticleRelationship(Base):
    __tablename__ = "article_relationships"

    id = Column(Integer, primary_key=True)
    from_article_id = Column(Integer, ForeignKey("articles.id"))
    to_article_id = Column(Integer, ForeignKey("articles.id"))


Article.related_articles = relationship(
    "Article",
    secondary="article_relationships",
    primary_key=from_article_id,
    secondary_key=to_article_id,
    backref="related_by"
)


Base.metadata.create_all(engine)

コードの説明:

Article エンティティ:
- id: 記事の主キーとなる整型数カラム
- title: 記事のタイトルを表す文字列カラム
- content: 記事の内容を表すテキストカラム
ArticleRelationship エンティティ (中間テーブル):
- from_article_id: 参照側の記事を表す外部キー (articles.id を参照)
related_articles リレーションシップ:
- Article エンティティに定義された多対多関係
- secondary 引数: 中間テーブル article_relationships を指定
- primary_key 引数: 中間テーブルの主キーカラム (from_article_id) を指定
- backref 引数: 逆方向の関係を related_by として定義

具体的な利用方法としては、記事の編集画面で関連する記事を選択できるようにしたり、記事を表示する際に関連する記事をリストアップしたりすることができます。

さらに、中間テーブルに weight などの属性を追加することで、関係の強さを表す情報を持たせることもできます。

このコードは、PostgreSQL や MySQL などの他のデータベースとも互換性があります。
関係を定義する際には、適切なインデックスを作成してパフォーマンスを向上させることを検討してください。

従来の多対多自己参照関係と同様に中間テーブルを使用しますが、このパターンでは、中間テーブルに特別な意味を持たせません。代わりに、関連するエンティティの ID を単に保存します。この方法の利点は、中間テーブルのスキーマがシンプルになることです。一方、欠点は、関係の向きや強度などの追加情報を保存できないことです。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String

engine = create_engine("sqlite:///junction_table.db")
Base = declarative_base()


class User(Base):
    __tablename__ = "users"

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

    followers = relationship(
        "User",
        secondary="junction_table",
        backref="following",
        lazy="dynamic"
    )


class JunctionTable(Base):
    __tablename__ = "junction_table"

    follower_id = Column(Integer, ForeignKey("users.id"), primary_key=True)
    followed_id = Column(Integer, ForeignKey("users.id"), primary_key=True)


Base.metadata.create_all(engine)

隣接リストパターン:

このパターンでは、各エンティティに、関連するエンティティの ID を保存するリスト属性を追加します。この方法の利点は、中間テーブルが不要になることです。一方、欠点は、関係の向きや強度などの追加情報を保存できないことと、N+1 クエリ問題が発生する可能性があることです。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String, Text

engine = create_engine("sqlite:///adjacency_list.db")
Base = declarative_base()


class Article(Base):
    __tablename__ = "articles"

    id = Column(Integer, primary_key=True)
    title = Column(String(255))
    content = Column(Text)
    related_article_ids = Column(String)


Base.metadata.create_all(engine)

JSON 型を使用する:

このパターンでは、関連するエンティティの ID を JSON 形式で保存する列を追加します。この方法の利点は、柔軟性が高く、関係の向きや強度などの追加情報を保存できることです。一方、欠点は、データベースのパフォーマンスが低下する可能性があることです。

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import Column, Integer, String, Text, JSON

engine = create_engine("sqlite:///json_type.db")
Base = declarative_base()


class Article(Base):
    __tablename__ = "articles"

    id = Column(Integer, primary_key=True)
    title = Column(String(255))
    content = Column(Text)
    related_article_ids = Column(JSON)


Base.metadata.create_all(engine)