Mapper クラス、configure_mappers 関数、XML マッピングの比較

2024-07-27

SQLAlchemy: Base がクラスのマッピングを認識する方法

Base は SQLAlchemy の ORM の基底クラスです。Base は、マッピングされたクラスを認識するために、いくつかの仕組みを組み合わせています。

仕組み:

__tablename__ 属性:
metadata 属性:
declarative デコレータ:
_decl_class_registry:

例:

from sqlalchemy import Column, Integer, String, Base

class User(Base):
    __tablename__ = 'users'

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

Base.metadata.create_all()

上記の例では、User クラスは Base クラスから継承しています。User クラスは、__tablename__ 属性と 2 つのカラム (id と name) を持っています。Base.metadata.create_all() メソッドは、データベースに users テーブルを作成します。

Base は、__tablename__ 属性、metadata 属性、declarative デコレータ、_decl_class_registry 変数を使用して、User クラスと users テーブルのマッピングを認識します。

SQLAlchemy は、高度な ORM 機能を提供します。詳細については、ドキュメントを参照してください。
Base クラスは、単なる基底クラスです。必要に応じて、独自の基底クラスを作成して、独自の機能を追加することができます。

from sqlalchemy import Column, Integer, String, Base, create_engine

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

# Base クラスを定義
class Base(object):
    __tablename__ = None

    def __init__(self, **kwargs):
        for key, value in kwargs.items():
            setattr(self, key, value)

# declarative デコレータを使用して User クラスを定義
@declarative.on_load(Base)
def on_load_base(cls, metadata, engine):
    # テーブルを作成
    cls.__table__.create(bind=engine, checkfirst=True)

class User(Base):
    __tablename__ = 'users'

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

# ユーザーを追加
user = User(name='John Doe')

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

# ユーザーを保存
session.add(user)

# セッションをコミット
session.commit()

# ユーザーを取得
user = session.query(User).filter(User.name == 'John Doe').one()

# ユーザーを削除
session.delete(user)

# セッションをコミット
session.commit()

# セッションを閉じる
session.close()

説明:

User クラスは、id と name という 2 つのカラムを持つテーブルを定義します。
on_load_base イベントハンドラは、User クラスのテーブルを作成します。
declarative デコレータは、Base クラスに on_load_base イベントハンドラを追加します。
Base クラスは、__tablename__ 属性と __init__ メソッドを定義しています。

実行方法:

上記のコードを Python ファイルに保存します。
Python ファイルを実行します。
SQLite データベースファイル (mydb.db) が作成されます。

SQLAlchemy でマッピングを定義する他の方法

方法:

Mapper クラス:
configure_mappers 関数:
XML マッピング:

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

# テーブルを定義
users_table = Table('users', metadata,
    Column('id', Integer, primary_key=True),
    Column('name', String)
)

# Mapper クラスを使用して User クラスを定義
class User(object):
    pass

mapper = Mapper(User, users_table)

from sqlalchemy import Column, Integer, String, Base, create_engine

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

# configure_mappers 関数を使用してマッピング設定を定義
def configure_mappers():
    Base.metadata.create_all(bind=engine)

# Base クラスを定義
class Base(object):
    __tablename__ = None

    def __init__(self, **kwargs):
        for key, value in kwargs.items():
            setattr(self, key, value)

# declarative デコレータを使用して User クラスを定義
@declarative.on_load(Base)
def on_load_base(cls, metadata, engine):
    configure_mappers()

class User(Base):
    __tablename__ = 'users'

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

# ユーザーを追加
user = User(name='John Doe')

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

# ユーザーを保存
session.add(user)

# セッションをコミット
session.commit()

# ユーザーを取得
user = session.query(User).filter(User.name == 'John Doe').one()

# ユーザーを削除
session.delete(user)

# セッションをコミット
session.commit()

# セッションを閉じる
session.close()

<sqlalchemy>
    <class name="User">
        <table name="users">
            <column name="id" primary_key="true" />
            <column name="name" />
        </table>
    </class>
</sqlalchemy>