SQLAlchemy

SQLAlchemy

作者	Michael Bayer
初版	2006年2月14日 (2006-02-14)
最新版	2.0.29  / 2024年3月23日
リポジトリ	github.com/sqlalchemy/sqlalchemy
プログラミング 言語	Python
対応OS	クロスプラットフォーム
サポート状況	開発中
種別	オブジェクト関係マッピング
ライセンス	MIT License
公式サイト	www.sqlalchemy.org

SQLAlchemyについて講演するMike Bayer (PyCon 2012)

SQLAlchemyは、Pythonプログラミング言語のためのオープンソースのSQLツールキットおよびオブジェクト関係マッピングライブラリ（ORM）で、MIT Licenseの下で公開されている。

概要

SQLAlchemyの哲学は、リレーショナルデータベースは規模が大きくなりパフォーマンスが懸念されるようになるにつれて、オブジェクトコレクションのように振る舞わなくなり、一方、オブジェクトコレクションは、抽象化が進むとテーブルや行のように振る舞わなくなる、という2つの原則に対応することである。このため、SQLAlchemyでは、他の多くのオブジェクトリレーショナルマッパーが採用しているアクティブレコードパターンではなく、データマッパーパターンを採用している（Java言語のHibernateと類似）。

歴史

SQLAlchemyは2006年2月に最初にリリースされた。

例

次の例は、映画とその監督との間の n対1 の関係を表している。ユーザー定義のPythonクラスに対応するデータベーステーブルを作成する方法、リレーションシップを持つインスタンスをリレーションの両側から作成する方法、最後にデータを検索する方法について、遅延読み込みと一括読み込みの両方で自動生成されたSQLクエリを説明する。

スキーマ定義

2つのPythonクラスとそれに対応するデータベーステーブルをDBMSに作成する。

from sqlalchemy import *
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relation, sessionmaker

Base = declarative_base()

class Movie(Base):
    __tablename__ = "movies"

    id = Column(Integer, primary_key=True)
    title = Column(String(255), nullable=False)
    year = Column(Integer)
    directed_by = Column(Integer, ForeignKey("directors.id"))

    director = relation("Director", backref="movies", lazy=False)

    def __init__(self, title=None, year=None):
        self.title = title
        self.year = year

    def __repr__(self):
        return "Movie(%r, %r, %r)" % (self.title, self.year, self.director)

class Director(Base):
    __tablename__ = "directors"

    id = Column(Integer, primary_key=True)
    name = Column(String(50), nullable=False, unique=True)

    def __init__(self, name=None):
        self.name = name

    def __repr__(self):
        return "Director(%r)" % (self.name)

engine = create_engine("dbms://user:pwd@host/dbname")
Base.metadata.create_all(engine)

データ挿入

監督と映画の関係は、どちらかのエンティティを介して挿入することができる。

Session = sessionmaker(bind=engine)
session = Session()

m1 = Movie("Robocop", 1987)
m1.director = Director("Paul Verhoeven")

d2 = Director("George Lucas")
d2.movies = [Movie("Star Wars", 1977), Movie("THX 1138", 1971)]

try:
    session.add(m1)
    session.add(d2)
    session.commit()
except:
    session.rollback()

クエリ

alldata = session.query(Movie).all()
for somedata in alldata:
    print(somedata)

SQLAlchemyは、DBMSに次のクエリを発行する（エイリアスは省略）。

SELECT movies.id, movies.title, movies.year, movies.directed_by, directors.id, directors.name
FROM movies LEFT OUTER JOIN directors ON directors.id = movies.directed_by

この出力は次のようになる。

Movie('Robocop', 1987L, Director('Paul Verhoeven'))
Movie('Star Wars', 1977L, Director('George Lucas'))
Movie('THX 1138', 1971L, Director('George Lucas'))

代わりに lazy=True （default）を指定すると、SQLAlchemyは、はじめに映画のリストを取得し、必要な場合のみ（遅延、lazy）それぞれの監督に対応する監督 の名前を取得するクエリを発行する。

SELECT movies.id, movies.title, movies.year, movies.directed_by
FROM movies

SELECT directors.id, directors.name
FROM directors
WHERE directors.id = %s

脚注

ノート

• Gift, Noah (2008年8月12日). “Using SQLAlchemy”. Developerworks. IBM. 2011年2月8日閲覧。
• Rick Copeland, Essential SQLAlchemy, O'Reilly, 2008, ISBN 0-596-51614-2

関連項目

• ORMライブラリ
  • SQLObject - SQLデータベースとPythonオブジェクト間のPythonオブジェクトリレーショナルマッパー
  • Storm (ソフトウェア) - SQLデータベースとPythonオブジェクト間のオブジェクトリレーショナルマッピング用のプログラミングライブラリ
• Python言語で記述されたWebアプリケーションフレームワーク
  • Pylons - ORMライブラリとしてSQLAlchemyを使用できる
  • TurboGears - バージョン2.0以降でORMライブラリとしてSQLAlchemyを採用
• Cubes (OLAPサーバ) - Python言語で記述された軽量なオープンソースの多次元モデリングおよびOLAPツール

外部リンク

• 公式ウェブサイト
• SQLAlchemy Tutorial