SQLAlchemyORM-関連オブジェクトの削除

1つのテーブルで削除操作を実行するのは簡単です。マップされたクラスのオブジェクトをセッションから削除し、アクションをコミットするだけです。ただし、複数の関連テーブルに対する削除操作は少し注意が必要です。

sales.dbデータベースでは、CustomerクラスとInvoiceクラスは、1対多のタイプの関係でcustomerおよびinvoiceテーブルにマップされます。Customerオブジェクトを削除して、結果を確認します。

クイックリファレンスとして、以下は顧客クラスと請求書クラスの定義です-

from sqlalchemy import create_engine, ForeignKey, Column, Integer, String
engine = create_engine('sqlite:///sales.db', echo = True)
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
from sqlalchemy.orm import relationship
class Customer(Base):
   __tablename__ = 'customers'

   id = Column(Integer, primary_key = True)
   name = Column(String)
   address = Column(String)
   email = Column(String)
   
class Invoice(Base):
   __tablename__ = 'invoices'

   id = Column(Integer, primary_key = True)
   custid = Column(Integer, ForeignKey('customers.id'))
   invno = Column(Integer)
   amount = Column(Integer)
   customer = relationship("Customer", back_populates = "invoices")
   
Customer.invoices = relationship("Invoice", order_by = Invoice.id, back_populates = "customer")

以下のプログラムを使用してプライマリIDでクエリを実行することにより、セッションをセットアップし、Customerオブジェクトを取得します。

from sqlalchemy.orm import sessionmaker
Session = sessionmaker(bind=engine)
session = Session()
x = session.query(Customer).get(2)

サンプルテーブルでは、x.nameはたまたま「GopalKrishna」です。このxをセッションから削除し、この名前の出現を数えましょう。

session.delete(x)
session.query(Customer).filter_by(name = 'Gopal Krishna').count()

結果のSQL式は0を返します。

SELECT count(*) 
AS count_1
FROM (
   SELECT customers.id 
   AS customers_id, customers.name 
   AS customers_name, customers.address 
   AS customers_address, customers.email 
   AS customers_email
   FROM customers
   WHERE customers.name = ?) 
AS anon_1('Gopal Krishna',) 0

ただし、xの関連する請求書オブジェクトはまだ存在します。次のコードで確認できます-

session.query(Invoice).filter(Invoice.invno.in_([10,14])).count()

ここで、10と14は、顧客のGopalKrishnaに属する請求書番号です。上記のクエリの結果は2です。これは、関連するオブジェクトが削除されていないことを意味します。

SELECT count(*) 
AS count_1
FROM (
   SELECT invoices.id 
   AS invoices_id, invoices.custid 
   AS invoices_custid, invoices.invno 
   AS invoices_invno, invoices.amount 
   AS invoices_amount
   FROM invoices
   WHERE invoices.invno IN (?, ?)) 
AS anon_1(10, 14) 2

これは、SQLAlchemyがカスケードの削除を想定していないためです。それを削除するコマンドを与える必要があります。

動作を変更するには、User.addresses関係にカスケードオプションを構成します。進行中のセッションを閉じ、新しいdeclarative_base（）を使用して、Userクラスを再宣言し、カスケード構成を含むアドレス関係を追加しましょう。

リレーションシップ関数のカスケード属性は、セッション操作を親から子に「カスケード」する方法を決定するカスケードルールのコンマ区切りのリストです。デフォルトではFalseです。これは、「保存-更新、マージ」であることを意味します。

利用可能なカスケードは次のとおりです-

• save-update
• merge
• expunge
• delete
• delete-orphan
• refresh-expire

よく使用されるオプションは「all、delete-orphan」で、関連するオブジェクトがすべての場合に親オブジェクトと一緒に続き、関連付けが解除されると削除されることを示します。

したがって、再宣言されたCustomerクラスを以下に示します-

class Customer(Base): 
   __tablename__ = 'customers'
   
   id = Column(Integer, primary_key = True) 
   name = Column(String) 
   address = Column(String) 
   email = Column(String) 
   invoices = relationship(
      "Invoice", 
      order_by = Invoice.id, 
      back_populates = "customer",
      cascade = "all, 
      delete, delete-orphan" 
   )

以下のプログラムを使用して、Gopal Krishna名の顧客を削除し、関連する請求書オブジェクトの数を確認しましょう-

from sqlalchemy.orm import sessionmaker
Session = sessionmaker(bind = engine)
session = Session()
x = session.query(Customer).get(2)
session.delete(x)
session.query(Customer).filter_by(name = 'Gopal Krishna').count()
session.query(Invoice).filter(Invoice.invno.in_([10,14])).count()

カウントは0になり、上記のスクリプトによって次のSQLが発行されます-

SELECT customers.id 
AS customers_id, customers.name 
AS customers_name, customers.address 
AS customers_address, customers.email 
AS customers_email
FROM customers
WHERE customers.id = ?
(2,)
SELECT invoices.id 
AS invoices_id, invoices.custid 
AS invoices_custid, invoices.invno 
AS invoices_invno, invoices.amount
AS invoices_amount
FROM invoices
WHERE ? = invoices.custid 
ORDER BY invoices.id (2,)
DELETE FROM invoices 
WHERE invoices.id = ? ((1,), (2,))
DELETE FROM customers 
WHERE customers.id = ? (2,)
SELECT count(*) 
AS count_1
FROM (
   SELECT customers.id 
   AS customers_id, customers.name 
   AS customers_name, customers.address 
   AS customers_address, customers.email 
   AS customers_email
   FROM customers
   WHERE customers.name = ?) 
AS anon_1('Gopal Krishna',)
SELECT count(*) 
AS count_1
FROM (
   SELECT invoices.id 
   AS invoices_id, invoices.custid 
   AS invoices_custid, invoices.invno 
   AS invoices_invno, invoices.amount 
   AS invoices_amount
   FROM invoices
   WHERE invoices.invno IN (?, ?)) 
AS anon_1(10, 14)
0