sqlalchemy

ORMとは何か？

SQL Alchemyの基本的な機能

1. ORM（Object Relational Mapping）

SQL Alchemyの基本キーワード

SQL AlchemyがDB操作する際の基盤構造

https://scrapbox.io/files/635d0e265d35240022030b04.png

最初は詳細をちゃんと理解しなくてもいい。「ふーん」くらいに抑えておけばOK。

SQL Alchemyの基本中の操作

Engineインスタンスを1つ作成して、DB操作のための基盤を作る

code: sample.py

from sqlalchemy import create_engine

engine = create_engine("postgresql://scott:tiger@localhost:5432/mydatabase")

「コネクションプーリング戦略」「プールサイズ」などもこの時行うことになる。

Engineは1システムに対して必ず1つだけ用意して使い回すこと。2つ以上作ってはいけない。

ORMを利用しない場合の基本操作

基本的には...

code: sample.py

with engine.connect() as connection:

result = connection.execute("select username from users")

for row in result:

トランザクションも使える

code: sample.py

with engine.connect() as connection:

with connection.begin():

r1 = connection.execute(table1.select())

connection.execute(table1.insert(), {"col1": 7, "col2": "this is some data"})

ORM対象となるオブジェクトを作る

code: sample.py

from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

code: sample.py

class User(Base):

"""

ユーザモデル

"""

__tablename__ = 'users'

__table_args__ = {

'comment': 'ユーザー情報のマスターテーブル'

}

id = Column('id', Integer, primary_key=True, autoincrement=True)

name = Column('name', String(200))

age = Column('age', Integer)

email = Column('email', String(100))

Baseを継承することで、このクラスをORMの操作対象にできる。

ORM対象オブジェクトをSessionでDB連携する

code: sample.py

Session = sessionmaker(bind=engine)

sessionmakerについては以下参考

code: sample.py

sesion = Session()

user = User(id=..., name=..., ...)

# 追加/更新

session.add(user)

session.commit()

#　削除

session.delete(user)

session.commit()

SQL Alchemyの覚えておきたいTips

DBとのコネクションの確立タイミングの遅延

なお、コネクションプールに待機中のものがある場合は、そのコネクションが利用されるだろう。

Sessionのトランザクションについて整理

Sessionでトランザクションを貼る方法は主に2つ存在する

code: sample.py

session = Session()

user = User(...)

session.add(user)

session.commit()

# ----- この時点でトランザクションが1度固まってる。

try:

session.add(user2)

session.flush()

except ...:

session.rollback()

# もしここでロールバックしたとしても、前のsession.commit()の結果は戻らない

もしエラーが発生したら、ロールバックする。

エラーが発生しなかったら、コミットする。

code: sample.py

session = Session()

user = User(...)

with session.begin():

session.add(user)

WebサービスでSQLAlchemyを利用する場合は、「scoped_session」を使おう

Webサービスでのリクエスト内で別々のSessionを使うのは非効率。

なので、リクエスト中は常に同じSessionを使えるようにしたい。

リクエスト毎にSessionをシングルトンにしてくれるので、毎回Sessionを作るのを削減できる。

code: sample.py

from sqlalchemy.orm import sessionmaker, scoped_session

Session = scoped_session(

sessionmaker(bind=engine)

)

参考：

Baseを使って、継承オブジェクトのテーブルを一括作成できる

code: sample.py

engine = create_engine("mysql+pymysql://<user>:<pass>@<host>/<dbname>?charset=utf8")

Base.metadata.create_all(bind=engine)

調査ログ

hr.icon

データ接続周りの話

code: settings.py

from sqlalchemy import create_engine

# 接続先DBの設定

DATABASE = 'sqlite:///db.sqlite3'

# Engine の作成

Engine = create_engine(

DATABASE,

encoding="utf-8",

echo=False

)

code: sample.py

session = Session(

autocommit = False,

autoflush = True,

bind = Engine

)

user = User()

user.name = '一郎'

session.add(user)

session.commit()

EngineはSQLAlchemyにおける出発点

https://scrapbox.io/files/635d0e265d35240022030b04.png

もちろん、DBAPIの仕様に則った上で。

Pool

これはコネクションプーリングのこと

コネクションプーリングが返すコネクションオブジェクトはDBAPIの仕様に則って実装されてるんだとよ。

というか...

Dialectオブジェクトが返ってるかも？？？

指定された方言に合わせたdialectオブジェクトが返ってる可能性ある

code: sample.py

from sqlalchemy import create_engine

engine = create_engine("postgresql://scott:tiger@localhost:5432/mydatabase")

メソッドが呼び出されるか、このメソッドに依存する操作が呼び出される まで、およびその基礎となるは 最初の実際の DBAPI 接続を確立しないことに注意してください。

URLの指定方法

postgresql

code: sample.py

# default

engine = create_engine("postgresql://scott:tiger@localhost/mydatabase")

# psycopg2

engine = create_engine("postgresql+psycopg2://scott:tiger@localhost/mydatabase")

# pg8000

engine = create_engine("postgresql+pg8000://scott:tiger@localhost/mydatabase")

なお、エンジンは実際にはDBへの接続そのものではありません（別にConnectionというクラスがある）。 内部でコネクションプーリングが行われており、エンジンのメソッドを実行するたびに随時コネクションの取得・解放を行なっています（Connection Pooling）。

接続プールは、アプリケーションが同時に使用する可能性のある接続の総数を管理するだけでなく、効率的に再利用するために長時間実行される接続をメモリ内に維持するために使用される標準的な手法です。

特にサーバー側の Web アプリケーションの場合、接続プールは、要求間で再利用されるアクティブなデータベース接続の「プール」をメモリ内に維持するための標準的な方法です。

コネクション数を適度にプーリングしてくれる感じで、制限超えたらそれ以上の接続を弾くようになる。

Engineこのセクションでは、 、 Connection、および関連オブジェクトの直接的な使用法について詳しく説明します。SQLAlchemy ORM を使用する場合、これらのオブジェクトは通常アクセスされないことに注意することが重要です。代わりに、Sessionオブジェクトはデータベースへのインターフェイスとして使用されます。ただし、ORM の上位レベルの管理サービスが関与することなく、テキスト SQL ステートメントや SQL 式構造を直接使用するように構築されたアプリケーションの場合、Engineと Connectionが王様 (そして女王様?) です。読み進めてください。

ORMを使う場合は、Sessionで操作する。

SQLを直接使う場合は、Engine, Connectionで操作する。

ここ重要なところ

create_engine()、特定のデータベース URL ごとに 1 回で、単一のアプリケーション プロセスの存続期間中グローバルに保持されます

engine, connectionを使ったDB操作の例

code: saple.py

from sqlalchemy import text

with engine.connect() as connection:

result = connection.execute(text("select username from users"))

for row in result:

トランザクションを作りたい場合は...

code: sample.py

with engine.connect() as connection:

with connection.begin():

r1 = connection.execute(table1.select())

connection.execute(table1.insert(), {"col1": 7, "col2": "this is some data"})

ホイホイ理解理解

境界づけられたトランザクション

code: sample.py

with session.begin():

session.add(some_object())

session.add(some_other_object())

# commits transaction at the end, or rolls back if there

# was an exception raised

上記のコンテキストの最後に、例外が発生しなかったと仮定すると、保留中のオブジェクトがデータベースにフラッシュされ、データベース トランザクションがコミットされます。上記のブロック内で例外が発生した場合、トランザクションはロールバックされます。どちらの場合も、 Sessionブロックを終了した後の上記は、後続のトランザクションで使用する準備ができています。