SQLAlchemy ORM: 複合キーを持つテーブルクラスの宣言 - 2つの主要な方法

2024-07-27

SQLAlchemy ORM: 複合キーを持つテーブルクラスの宣言

方法1: ColumnデコレータとForeignKey

この方法は、複数の列を直接テーブルクラスに定義し、それぞれにForeignKeyデコレータを使用して参照するテーブルを指定します。

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

class Customer(Base):
    __tablename__ = 'customers'

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    address_id = Column(Integer, ForeignKey('addresses.id'))

    address = relationship('Address', backref='customers')

class Address(Base):
    __tablename__ = 'addresses'

    id = Column(Integer, primary_key=True)
    street = Column(String(255))
    city = Column(String(255))
    state = Column(String(255))
    country = Column(String(255))

この例では、Customerテーブルにはid、name、address_idという3つの列があります。address_id列はAddressesテーブルのid列を参照する外部キーです。Addressテーブルにはid、street、city、state、countryという5つの列があります。

方法2: Compositeデコレータ

この方法は、複合キーを定義するためにCompositeデコレータを使用します。Compositeデコレータは、複数の列を単一の属性としてグループ化することができます。

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship

Base = declarative_base()

class Customer(Base):
    __tablename__ = 'customers'

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    address = Column(ForeignKey('addresses.id'))

    address_info = relationship('Address', backref='customer')

class Address(Base):
    __tablename__ = 'addresses'

    id = Column(Integer, primary_key=True)
    street = Column(String(255))
    city = Column(String(255))
    state = Column(String(255))
    country = Column(String(255))

どちらの方法を選択するかは、個々の状況によって異なります。一般的には、ColumnデコレータとForeignKeyの方がシンプルでわかりやすいコードになりますが、Compositeデコレータの方が柔軟性があり、複雑な複合キーを定義するのに適しています。

複合キーを持つテーブルをクエリするには、in演算子を使用します。

customer = session.query(Customer).filter(Customer.address == (123, 'Main Street')).first()

複合キーを持つテーブルを更新するには、update()メソッドを使用します。

session.query(Customer).filter(Customer.address == (123, 'Main Street')).update({'name': 'John Doe'})

session.query(Customer).filter(Customer.address == (123, 'Main Street')).delete()

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

engine = create_engine('sqlite:///database.db')
Base = declarative_base()

class Customer(Base):
    __tablename__ = 'customers'

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    address_id = Column(Integer, ForeignKey('addresses.id'))

    address = relationship('Address', backref='customers')

class Address(Base):
    __tablename__ = 'addresses'

    id = Column(Integer, primary_key=True)
    street = Column(String(255))
    city = Column(String(255))
    state = Column(String(255))
    country = Column(String(255))

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

# データ挿入
customer1 = Customer(name='John Doe', address_id=1)
customer2 = Customer(name='Jane Doe', address_id=2)

address1 = Address(street='123 Main Street', city='Anytown', state='CA', country='USA')
address2 = Address(street='456 Elm Street', city='Anytown', state='CA', country='USA')

session.add_all([customer1, customer2, address1, address2])
session.commit()

# データ取得
customer = session.query(Customer).filter(Customer.address == (123, 'Main Street')).first()
print(customer.name)  # 'John Doe'

address = session.query(Address).filter(Address.id == 1).first()
print(address.street)  # '123 Main Street'

このコードを実行すると、database.dbという名前のSQLiteデータベースにcustomersとaddressesという2つのテーブルが作成されます。customersテーブルには、顧客のID、名前、住所IDという3つの列があります。addressesテーブルには、住所のID、番地、市区町村、州、国という5つの列があります。

この方法は、PrimaryKeyConstraintデコレータを使用して、複数の列を主キーとして定義します。

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship

Base = declarative_base()

class Customer(Base):
    __tablename__ = 'customers'

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

    address = relationship('Address', backref='customer')

class Address(Base):
    __tablename__ = 'addresses'

    customer_id = Column(Integer, ForeignKey('customers.id'), primary_key=True)
    street = Column(String(255), primary_key=True)
    city = Column(String(255))
    state = Column(String(255))
    country = Column(String(255))

この例では、Customerテーブルにはid、name、street、cityという4つの列があります。streetとcity列は主キーとして定義されています。Addressテーブルにはcustomer_id、street、city、state、countryという5つの列があります。customer_id列はCustomersテーブルのid列を参照する外部キーです。street列はCustomerテーブルのstreet列を参照する外部キーであり、主キーの一部でもあります。

方法4: CompositeデコレータとPrimaryKeyConstraint

この方法は、CompositeデコレータとPrimaryKeyConstraintデコレータを組み合わせて、複合キーを定義します。

from sqlalchemy import Column, Integer, String, ForeignKey
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship
from sqlalchemy.sql.expression import tuple_

Base = declarative_base()

class Customer(Base):
    __tablename__ = 'customers'

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

    address = relationship('Address', backref='customer')

class Address(Base):
    __tablename__ = 'addresses'

    customer_id = Column(Integer, ForeignKey('customers.id'))
    address = Column(tuple_(Column(String(255)), Column(String(255))), primary_key=True)

    def __init__(self, street, city):
        self.street = street
        self.city = city

    @property
    def full_address(self):
        return f'{self.street}, {self.city}'

この例では、Customerテーブルにはidとnameという2つの列があります。Addressテーブルにはcustomer_id、street、cityという3つの列があります。customer_id列はCustomersテーブルのid列を参照する外部キーです。streetとcity列は複合キーとして定義されています。