【SQLAlchemy】insertしたレコードのidを取得・利用

この記事はなに

SQLAlchemyにおいて新規作成したレコードのid値を取得・利用する方法を書いたメモ

前置き

# Userテーブルのレコードを新規作成

# 続けて作成したuserのidをuser_idとしてauthorizationレコードを作成

というような操作をしたい場合、
みんな大好きRuby on RailsのORMであるActive Recordなどでは

user = User.create!(test_column=‘test’)
# user.id -> 2

# 続けてuser.idをuser_idとしてauthorizationレコードを作成

と直感的に書けるが、

FlaskやBottleなどのPythonの軽量フレームワークでしばしば使用されるORMであるSQLAlchemyでは書き方が直感的ではない気がしたので雑メモする

本題

SQLAlchemyのinsertにおいてidが確定するタイミングは

db = SQLAlchemy()

user = User(test_column=‘test’)
db.session.add(user)
db.session.commit()

のcommit部分なので

user = User(test_column=‘test’)
# user.id -> None

db.session.add(user)
# user.id -> None

db.session.commit()
# user.id -> 2

# 続けてuser.idをuser_idとしてauthorizationレコードを作成

のように(考えてみれば当たり前だが) commit()したタイミングで、userが変化してid が取得できるようになる。

また、もちろんネストを使って以下のように書いても

db.session.begin_nested()
# user.id -> 2

とidが確定する。