【理解度チェックテスト付き】SQLAlchemyの基本的な使い方

$ pip3 install sqlalchemy

# pip3コマンドを使うために必要なものをインストール
$ sudo apt update
$ sudo apt install python3-pip

# SQLAlchemyのインストール
$ pip3 install sqlalchemy

# エンジン作成のための関数をimport
>>> from sqlalchemy import create_engine

# エンジンオブジェクトの作成
>>> engine = create_engine('sqlite:///:memory:', echo=True)

>>> engine = create_engine('postgresql://username:password@hostname/database_name', echo=True)

from sqlalchemy import Table, Column, Integer, String, MetaData, ForeignKey

# MetaDataをインスタンス化
metadata = MetaData()

# Tableインスタンスを作成(第一引数：テーブル名,第二引数：metadata、第三引数以降：カラム）
# また、同時にmetadataの管理対象としてusersテーブルを登録
users_table = Table('users',
                    metadata,
                    Column('id', Integer, primary_key=True),
                    Column('name', String),
                    Column('fullname', String),
                    Column('password', String))

# engineで設定されているDBにmetadataの管理化にあるテーブルをすべて作成
metadata.create_all(engine)

class User:
    def __init__(self, name, fullname, password):
        self.name = name
        self.fullname = fullname
        self.password = password

    def __repr__(self):
        # __repr__メソッドは"print(Userインスタンス)"した時に出力する値を決めることができる。
        return "<User('%s','%s', '%s')>" % (self.name, self.fullname, self.password)

# __repr__がない場合
>>> class User:
...     def __init__(self, name, fullname, password):
...         self.name = name
...         self.fullname = fullname
...         self.password = password
...

>>> ed_user = User('ed', 'Ed Jones', 'edspassword')
>>> print(ed_user)
<__main__.User object at 0x7fb07929c320>
# この出力結果ではインスタンスがどんな値を持っているか分からない。

# __repr__がある場合
>>> class User:
...     def __init__(self, name, fullname, password):
...         self.name = name
...         self.fullname = fullname
...         self.password = password
...     def __repr__(self):
...         return "<User('%s','%s', '%s')>" % (self.name, self.fullname, self.password)
...

>>> ed_user = User('ed', 'Ed Jones', 'edspassword')
>>> print(ed_user)
<User('ed','Ed Jones', 'edspassword')>
# インスタンス変数の中身が見れる！

>>> from sqlalchemy.orm import mapper
>>> mapper(User, users_table)
<Mapper at 0x7fb07531ce10; User>

# マッピング完了後に以下を実行

>>> ed_user = User('ed', 'Ed Jones', 'edspassword')

>>> ed_user.name
'ed'

>>> ed_user.password
'edspassword'

>>> print(ed_user.id)
None

>>> class Dog:
...     def __init__(self, name):
...         self.name = name
...

>>> pochi = Dog("pochi")
>>> pochi.name
'pochi'

>>> pochi.id
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
AttributeError: 'Dog' object has no attribute 'id'

# declarative_base関数のインポート
from sqlalchemy.ext.declarative import declarative_base

# MetaDataの機能や関連付けの機能を持つBaseオブジェクトを作成
Base = declarative_base()

# Baseを継承させることでBaseのもつMetaDataにこのクラスが登録される
class User(Base):
    # 関連づけるテーブル名を指定
    __tablename__ = 'users'

    # テーブルのカラム情報をクラス変数として持たせる
    id = Column(Integer, primary_key=True)
    name = Column(String)
    fullname = Column(String)
    password = Column(String)

    # id以外のカラム名のインスタンス変数を作成(idはDBに登録される際に自動で割り振られるので不要)
    def __init__(self, name, fullname, password):
        self.name = name
        self.fullname = fullname
        self.password = password

    # Userクラスのインスタンスの出力結果を設定（作成は任意）
    def __repr__(self):
        return "<User('%s','%s', '%s')>" % (self.name, self.fullname, self.password)

>>> Base.metadata.create_all(engine)
~~出力一部省略~~
CREATE TABLE users (
        id SERIAL NOT NULL,
        name VARCHAR,
        fullname VARCHAR,
        password VARCHAR,
        PRIMARY KEY (id)
)
~~出力一部省略~~
# テーブル名"users"はUserクラスのクラス変数__tablename__に格納された文字列を取ってきている

>>> from sqlalchemy.orm import sessionmaker
>>> Session = sessionmaker(bind=engine)
>>> session = Session()
# Sessionクラスのインスタンス（session）にはエンジン設定が含まれている。
# このsessionを利用してDB操作を行う。

# usersテーブルとマッピングされているUserクラスからインスタンス化
>>> ed_user = User('ed', 'Ed Jones', 'edspassword')

# セッションに追加
>>> session.add(ed_user)
# この時点ではまだセッションに乗せているだけであり、DBの方には反映されていません。
# Amazonでカートには入れたけど、まだ購入は完了していない感じ

# DBに反映
>>> session.commit()
# commitが行われて初めてDB側に反映が確定します。
# Amazonでいうと購入を確定させた感じ

session.query(~).all()

# 一人目はcommitまでする
>>> ed_user = User('ed', 'Ed Jones', 'edspassword')
>>> session.add(ed_user)
>>> session.commit()

# 二人目はcommitせずaddだけ
>>> ed_user2 = User('ed2', 'Ed2 Jones', 'ed2spassword')
>>> session.add(ed_user2)

# allの戻り値の確認
>>> session.query(User).all()
[<User('ed','Ed Jones', 'edspassword')>, <User('ed2','Ed2 Jones', 'ed2spassword')>]
# commitしていないed2のインスタンスまで持ってこれた

# ついでにfilterを使った場合
session.query(User).filter(User.name=='ed').all()
[<User('ed','Ed Jones', 'edspassword')>]
# filter条件に合致したedを取得し、合致しなかったed2は取得しなかった。

# all()ではなくfirst()で取得するのでリストではなくインスタンスの形で返ってくる
>>> ed_user = session.query(User).filter(User.name=='ed').first()
>>> ed_user
<User('ed','Ed Jones', 'edspassword')>

# インスタンス変数に代入
>>> ed_user.name = 'edy'
>>> ed_user
<User('edy','Ed Jones', 'edspassword')

>>>> session.commit()
2019-08-21 22:52:04,419 INFO sqlalchemy.engine.base.Engine UPDATE users SET name=? WHERE users.id = ?
2019-08-21 22:52:04,419 INFO sqlalchemy.engine.base.Engine ('edy', 1)
2019-08-21 22:52:04,419 INFO sqlalchemy.engine.base.Engine COMMIT
# ログ出力されているSQL文からレコードの更新(UPDATEが行われていることが分かる)

>>> session.query(User).filter(User.name=='edy').delete()
>>> session.commit()

# 消えたか確認
>>> ed_user = session.query(User).filter(User.name=='edy').first()
>>> ed_user
>>>
# ed_userを出力しようとしてみたが、何も出力されない
# これはqueryの結果が空であったことを表しているのでちゃんと削除されていることが分かる

from sqlalchemy import create_engine
from sqlalchemy import Table, Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker


engine = create_engine('sqlite:///:memory:', echo=True)
Base = declarative_base()

class User(Base):
    __tablename__ = 'users'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    fullname = Column(String)
    password = Column(String)

    def __init__(self, name, fullname, password):
        self.name = name
        self.fullname = fullname
        self.password = password

    def __repr__(self):
        return "<User('%s','%s', '%s')>" % (self.name, self.fullname, self.password)


Base.metadata.create_all(engine)
Session = sessionmaker(bind=engine)
session = Session()

ed_user = User('ed', 'Ed Jones', 'edspassword')
session.add(ed_user)
session.commit()

ed_user2 = User('ed2', 'Ed2 Jones', 'ed2spassword')
session.add(ed_user2)

ed_user = session.query(User).filter(User.name=='ed').first()
ed_user.name = 'edy'
session.query(User).filter(User.name=='ed').delete()
session.commit()

all_users = session.query(User).all()

print(all_users)