Python SQLAlchemy ORM - 3

Posted on  Sep 28, 2016  in  Python 模組/套件推薦 , Python 程式設計 - 高階  by  Amo Chen  ‐ 5 min read

本文為 Python SQLAlchemy ORM 一系列教學文:

刪除

學會如何查詢之後,就能夠進行後續的刪除、更新等操作。

同樣地,以幾個範例做為學習的捷徑。

user_1 = User('user1', 'username1', 'password_1')
user_2 = User('user2', 'username2', 'password_2')
session.add(user_1)
session.add(user_2)
affected_rows = session.query(User).filter_by(id=1).delete()
print('Affected rows:', affected_rows)

if session.query(User).filter_by(id=1).count() == 0:
    print('id 1 not found')

上述的範例中,將 id 為 1 的 user 查詢出來後,直接呼叫 delete() 方法進行刪除。

呼叫 delete() 後會回傳刪除成功的資料筆數。

更新

事實上,更新也只需要呼叫 update() 並提供欄位名稱與欄位值的 dictionary 做為參數即可。

user_1 = User('user1', 'username1', 'password_1')
user_2 = User('user2', 'username2', 'password_2')
session.add(user_1)
session.add(user_2)
affected_rows = session.query(User).filter_by(id=1).update({'id':3, 'username': 'sqlalchemy'})
print('Affected rows:', affected_rows)

for r in session.query(User):
    print(r.id, r.username)

表格關聯(Relationship)

SQLAlchemy ORM 最大的特點就是能夠透過 Python 類別間關聯的建立,實作資料庫表格間的關聯,能夠讓程式開發者很方便的取得相關聯的資料。

而關聯的種類有:

  • One to Many
  • Many to one
  • One to one
  • Many to Many

分別代表一筆資料與另一個表格的資料間的關係。

如果有興趣了解的人可以詳閱 Basic Relationship Patterns

接下來同樣用一個範例了解 SQLAlchemy ORM 的表格關聯。範例中,除了原先已經定義過的 User 類別之外,還會再多定義一個 Address 類別,兩者間的關係為一對多,代表一個 user 允許有多個 address 。

一對多關聯

# -*- coding: utf-8 -*-
import hashlib
import sqlalchemy.orm
from sqlalchemy import create_engine
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import ForeignKey
from sqlalchemy.orm import relationship, backref
from sqlalchemy.orm import sessionmaker
from sqlalchemy import desc
from sqlalchemy.orm import aliased
from sqlalchemy import func

Base = declarative_base()

class User(Base):

    __tablename__ = 'user'

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

    def __init__(self, name, username, password):
        self.name = name
        self.username = username
        self.password = hashlib.sha1(password).hexdigest()

    def __repr__(self):
        return "User('{}','{}', '{}')".format(
            self.name,
            self.username,
            self.password
        )


class Address(Base):

    __tablename__ = 'user_address'

    id = Column(Integer, primary_key=True)
    address = Column(String, nullable=False)
    user_id = Column(Integer, ForeignKey('user.id'))
    user = relationship('User', backref=backref('address', order_by=id))

    def __init__(self, address):
        self.address = address

    def __repr__(self):
        return "Address('{}')".format(self.address)

if __name__ == '__main__':
    engine = create_engine('sqlite:///:memory:', echo=True)
    Base.metadata.create_all(engine)

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

    user_1 = User('user1', 'username1', 'password_1'.encode('utf-8'))
    user_2 = User('user2', 'username2', 'password_2'.encode('utf-8'))
    user_1.address = [Address('臺灣凱達格蘭大道')]
    user_2.address = [Address('美國紐約時代廣場'), Address('美國華盛頓DC')]
    session.add(user_1)
    session.add(user_2)

    for r in session.query(Address):
        print(r.id, r.address, r.user_id)

    for r in session.query(User):
        for a in r.address:
            print(r.username, 'living at', a.address)

範例說明:

首先看到第 7, 8 行 import 所需的模組( ForeignKey, relationship, backref ) 。

然後在第 38 - 51 行的部份進行 Address 類別的定義,其中第 44 行定義了一個關聯至 user.id 的 Foreign Key,宣告了它是一個指到 user.id 的 Foreign Key。

並且在第 45 行以 relationship() 方法定義類別 Address 與類別 User 間有一個參照的關聯存在。 SQLAlchemy ORM 就會依照 backref('address', order_by=id) 所定義的關聯,將 User 與 Address 之間以 address 屬性關聯起來。

若第 45 行單單只有 relationship('User') 就代表只是單向的從 Address 到 User 之間的關聯存在(Address → User),但由於我們希望查詢 User 時也能夠得知 User 到那些 Address 的資料,因此就得從 User 關聯回 Address (User → Address),形成一種雙向的關係(User ↔ Address) ,在 SQLAlchemy 中,就稱這種雙向的關係為 backref 。因此在第 45 行可以看到 backref('address', order_by=id),其實就是代表若要從 User 關聯回 Address 就得存取 User 的 address 屬性。

backref – indicates the string name of a property to be placed on the related mapper’s class that will handle this relationship in the other direction. The other property will be created automatically when the mappers are configured. Can also be passed as a backref() object to control the configuration of the new relationship.

第 60, 61 行分別指定了 user_1 , user_2 的地址,然後在第 64, 65 行將這些資料一併新增到資料庫內(包含 Address 的部份, SQLAlchemy 會自動處理)。

第 70 行查詢資料庫內的所有 user 資料,並且透過 relationship('User', backref=backref('address', order_by=id)) 中所指明的 backref('address', order_by=id),以 address 屬性取得與 User 有關聯的 Address 相關資料。 最後,由於 User 與 Address 之間是一對多的關係,因此需要在第 71 行以一個迴圈將各自的 Address 實例一一取出。

一對一關聯

預設的關聯就是一對多,因此我們可以看到前述的範例是以 list 的進行新增,如 user_2.address = [Address('美國紐約時代廣場'), Address('美國華盛頓DC')]

可是有些時候我們會限制資料間只能有一對一的關係存在,此時就需要在 backref() 中加上 uselist=False 做為參數,以表明一對一的關係。

例如前述範例的第 45 行可變更為:

backref('address', uselist=False, order_by=id)

那麼在第 62, 63 行就不需再以 list 的形式指定,同時在第 71 行也不需要再多一個迴圈將各別的 Address 取出。 多對一關聯 同樣以 User, Address 兩個類別作為例子,試想當多個使用者住在同一個地址時,就是多對一的情況。

此時,前述範例就得稍作變更,變成將 Address 的 Foreign Key 移除,而改至 User 中,並將關係指向 Address。同時,我們已不再需要從 Address 雙向關聯回 User ,因此在 relationship() 中也不需再指定 backref

多對一關聯範例如下:

# -*- coding: utf-8 -*-
import hashlib
import sqlalchemy.orm
from sqlalchemy import create_engine
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import ForeignKey
from sqlalchemy.orm import relationship, backref
from sqlalchemy.orm import sessionmaker
from sqlalchemy import desc
from sqlalchemy.orm import aliased
from sqlalchemy import func

Base = declarative_base()

class User(Base):

    __tablename__ = 'user'

    id = Column(Integer, primary_key=True)
    name = Column(String)
    username = Column(String)
    password = Column(String)
    address_id = Column(Integer, ForeignKey('user_address.id'))
    address = relationship('Address')

    def __init__(self, name, username, password):
        self.name = name
        self.username = username
        self.password = hashlib.sha1(password).hexdigest()

    def __repr__(self):
        return "User('{}','{}', '{}')".format(
            self.name,
            self.username,
            self.password
        )


class Address(Base):

    __tablename__ = 'user_address'

    id = Column(Integer, primary_key=True)
    address = Column(String, nullable=False)

    def __init__(self, address):
        self.address = address

    def __repr__(self):
        return "Address('{}')".format(self.address)


if __name__ == '__main__':
    engine = create_engine('sqlite:///:memory:', echo=True)
    Base.metadata.create_all(engine)

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

    user_1 = User('user1', 'username1', 'password_1'.encode('utf-8'))
    user_2 = User('user2', 'username2', 'password_2'.encode('utf-8'))
    address_1 = Address('臺灣凱達格蘭大道')
    user_1.address = address_1
    user_2.address = address_1
    session.add(user_1)
    session.add(user_2)

    for r in session.query(User):
        print(r.username, 'living at', r.address.address)
        print('Address_id:', r.address_id)

多對多關聯

第 4 種關聯的形式為多對多關聯,先前提到一對一、一對多、多對一的關聯都是屬於直接形式的 A ↔ B 型,然而 SQLAlchemy 的多對多做法是用一個中介的 association table 來多對多映對,就成為一種 A ↔ association table ↔ B 的間接關聯形式。

接下來同樣用一個範例說明:

# -*- coding: utf-8 -*-
import hashlib
import sqlalchemy.orm
from sqlalchemy import create_engine
from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy import ForeignKey
from sqlalchemy.orm import relationship, backref
from sqlalchemy.orm import sessionmaker
from sqlalchemy import desc
from sqlalchemy.orm import aliased
from sqlalchemy import func
from sqlalchemy import Table

Base = declarative_base()

association_table = Table(
    'association',
    Base.metadata,
    Column('table_a_id', Integer, ForeignKey('table_a.id')),
    Column('table_b_id', Integer, ForeignKey('table_b.id'))
)


class A(Base):
    __tablename__ = 'table_a'
    id = Column(Integer, primary_key=True)
    children = relationship('B', secondary=association_table)


class B(Base):
    __tablename__ = 'table_b'
    id = Column(Integer, primary_key=True)


if __name__ == '__main__':
    engine = create_engine('sqlite:///:memory:')
    Base.metadata.create_all(engine)

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

    b_list = [B(), B(), B()]
    a_1 = A()
    a_2 = A()
    a_1.children = b_list
    a_2.children = b_list
    session.add(a_1)
    session.add(a_2)
    session.commit()

    for a in session.query(A):
        print('A:', a.id, 'has relationship with')
        for b in a.children:
            print('\tB:', b.id)

以下是執行結果:

A: 1 has relationship with
    B: 1
    B: 2
    B: 3
A: 2 has relationship with
    B: 1
    B: 2
    B: 3

如果有將 sessionmaker()echo=True 選項打開的話,就可以發現 SQLAlchemy 將 A 與 B 的對應 id 存至 association 的訊息。

如下所示:

2013-09-01 11:46:20,862 INFO sqlalchemy.engine.base.Engine INSERT INTO association (table_a_id, table_b_id) VALUES (?, ?)
2013-09-02 11:46:20,862 INFO sqlalchemy.engine.base.Engine ((1, 1), (1, 2), (1, 3), (2, 1), (2, 2), (2, 3))

範例說明:

第 17 行定義了一個 association table 用來做為多對多的間接映射的資料表格,Table() 會用 Metadata 來關聯到 declarative base class ,所以 ForeignKey() 就可以分別建立連結到 table_a , table_b

第 25 - 33 行定義了 2 個類別 A, B,其中第 28 行以 relationship('B', secondary=association_table) 指明與 B 之間有關聯存在,並且以 secondary=association_table 指明透過 association_table 建立多對多的關係。 第 43 - 50 行則是建立多對多的資料。

最後在第 52 - 55 行將資料庫內的結果列印出來。

值得注意的是在範例中並沒有建立雙向的關係,如果要查詢 B 時也能夠得知與 A 的關聯,就得在 A 類別的 relationship() 加上 backref=backref('children') 指明雙向關係,如此一來 B 就可以透過存取 children 屬性取得相關聯的 A 。

多對多關聯的刪除

在多對多的關聯下,若刪除一筆資料,並不需要手動更新 association table 內的資料,SQLAlchemy 會自動進行更新。 除了多對多的資料關聯是自動 cascade 刪除之外,其他的關聯就得自行在 relationship() 指明使用 cascade 刪除,例如:

addresses = relationship('Address', backref='user', cascade='all, delete, delete-orphan')

詳見 Configuring delete/delete-orphan Cascade

結語

至此,已解說完大部份的 SQLAlchemy ORM 的功能。剩下的功能就得靠各位自行探索囉!

FOLLOW US

對抗久坐職業傷害

研究指出每天增加 2 小時坐著的時間,會增加大腸癌、心臟疾病、肺癌的風險,也造成肩頸、腰背疼痛等常見問題。

然而對抗這些問題,卻只需要工作時定期休息跟伸展身體即可!

你想輕鬆改變現狀嗎?試試看我們的 PomodoRoll 番茄鐘吧! PomodoRoll 番茄鐘會根據你所設定的專注時間,定期建議你 1 項辦公族適用的伸展運動,幫助你打敗久坐所帶來的傷害!

贊助我們的創作

看完這篇文章了嗎? 休息一下,喝杯咖啡吧!

如果你覺得 MyApollo 有讓你獲得實用的資訊,希望能看到更多的技術分享,邀請你贊助我們一杯咖啡,讓我們有更多的動力與精力繼續提供高品質的文章,感謝你的支持!