SQLAlchemyで多対多関係を極める！自身のテーブルとの関係を宣言的に構築
SQLAlchemy: 自身のテーブルとの多対多関係を宣言的に設定する方法
このチュートリアルでは、宣言的な方法で self-referential many-to-many 関係を設定する方法を説明します。
手順
- 関係を定義する
まず、self-referential many-to-many 関係を定義する必要があります。これを行うには、relationship() デコレータを使用します。
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.ext.declarative import declarative_base
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')
# 多対多関係をマッピングするテーブルを作成する
followers_table = Table(
'followers',
Base.metadata,
Column('follower_id', Integer, ForeignKey('users.id')),
Column('followed_id', Integer, ForeignKey('users.id'))
)
上記のコードでは、User テーブルと自身のテーブルとの many-to-many 関係を定義しています。これは、followers という名前のリレーションシップを使用して行われます。
関係を定義したら、followers 属性を使用して、ユーザーがフォローしている他のユーザーにアクセスできます。
user1 = User(name='John Doe')
user2 = User(name='Jane Doe')
user1.followers.append(user2)
print(user1.followers)
上記のコードでは、user1 が user2 をフォローするように設定しています。次に、user1.followers 属性を使用して、user1 がフォローしているユーザーのリストを取得しています。
self-referential many-to-many 関係は、テーブルと自身のテーブル間で多対多の関係を定義するのに役立ちます。これは、1 つのレコードが別のレコードと複数の関係を持つことができる場合に役立ちます。
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.ext.declarative import declarative_base
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')
# 多対多関係をマッピングするテーブルを作成する
followers_table = Table(
'followers',
Base.metadata,
Column('follower_id', Integer, ForeignKey('users.id')),
Column('followed_id', Integer, ForeignKey('users.id'))
)
# ユーザーを作成する
user1 = User(name='John Doe')
user2 = User(name='Jane Doe')
user3 = User(name='Peter Jones')
# ユーザー間の関係を設定する
user1.followers.append(user2)
user1.followers.append(user3)
user2.followers.append(user3)
# フォロワーのリストを取得する
print(user1.followers) # 出力: [User(name='Jane Doe'), User(name='Peter Jones')]
print(user2.followers) # 出力: [User(name='Peter Jones')]
print(user3.followers) # 出力: []
Userテーブルを作成します。このテーブルには、idとnameという 2 つのカラムがあります。Userテーブルと自身のテーブル間のmany-to-many関係を定義します。この関係はfollowersと呼ばれ、followers_tableという中間テーブルを使用してマッピングされます。- 3 人のユーザーを作成します。
- ユーザー間の関係を設定します。
- 各ユーザーのフォロワーのリストを取得します。
secondary パラメータを使用しない方法
secondary パラメータを使用せずに、relationship() デコレータを使用して self-referential many-to-many 関係を定義できます。
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class User(Base):
__tablename__ = 'users'
id = Column(Integer, primary_key=True)
name = Column(String(255))
# 自身のテーブルとの多対多関係を定義する
followers = relationship('User',
secondary='followers',
primaryjoin=id==followers.c.follower_id,
secondaryjoin=id==followers.c.followed_id)
# 多対多関係をマッピングするテーブルを作成する
followers = Table(
'followers',
Base.metadata,
Column('follower_id', Integer, ForeignKey('users.id')),
Column('followed_id', Integer, ForeignKey('users.id'))
)
このコードは、上記で紹介したコードとほぼ同じですが、secondary パラメータを使用していません。代わりに、primaryjoin と secondaryjoin パラメータを使用して、関係の結合条件を定義しています。
passive_deletes オプションを使用する
passive_deletes オプションを使用して、関連レコードが削除されたときに、中間テーブルのエントリが自動的に削除されるように設定できます。
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.ext.declarative import declarative_base
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',
passive_deletes=True)
# 多対多関係をマッピングするテーブルを作成する
followers_table = Table(
'followers',
Base.metadata,
Column('follower_id', Integer, ForeignKey('users.id')),
Column('followed_id', Integer, ForeignKey('users.id'))
)
このコードでは、passive_deletes オプションを True に設定しています。これにより、User レコードが削除されると、followers_table から関連するエントリが自動的に削除されます。
cascade オプションを使用する
cascade オプションを使用して、関連レコードが削除されたときに、中間テーブルのエントリだけでなく、関連レコードも削除されるように設定できます。
from sqlalchemy import Column, Integer, String, Table
from sqlalchemy.ext.declarative import declarative_base
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',
cascade='all, delete-orphan')
# 多対多関係をマッピングするテーブルを作成する
followers_table = Table(
'followers',
Base.metadata,
Column('follower_id', Integer, ForeignKey('users.id')),
Column('followed_id', Integer, ForeignKey('users.id'))
)
このコードでは、cascade オプションを 'all, delete-orphan' に設定しています。これにより、User レコードが削除されると、followers_table から関連するエントリが自動的に削除され、関連する User レコードも削除されます。
これらの方法は、SQLAlchemy で self-referential many-to-many 関係を宣言的に設定するために使用できるものです。どの方法を使用するかは、特定のニーズによって異なります。
- 関連レコードが削除されたときに中間テーブルのエントリが自動的に削除されるように設定する必要がある
- シンプルな関係の場合は、
secondaryパラメータを使用しない方法が最も簡単です。
sqlalchemy
