SQLAlchemy 如何序列化父对象及其子对象？

python

2024-03-01 15:42:26

SQLAlchemy：序列化父对象及其子对象

简介

在使用 SQLAlchemy 查询父类及其子类时，我们经常会遇到一个问题，即无法在序列化后获取子类。这是因为 SQLAlchemy 默认使用惰性加载，意味着只有在需要时才会从数据库中检索子类。

问题

你可能遇到以下问题：

尽管在代码中使用了 relationship() 关系，但在序列化后，父对象不包含其子对象。
当尝试访问父对象的子对象时，会触发一个数据库查询。

解决方案

为了解决这个问题，我们需要显式地使用联接加载，而不是惰性加载。联接加载将在查询父对象时自动检索子类。

1. 使用联接加载

在查询中，使用 Join 类指定要联接的子类表：

query = session.query(User).join(DomainName)

2. 指定 eagerload() 选项

通过 eagerload() 选项指定 SQLAlchemy 在加载父对象时自动加载子对象：

query = session.query(User).options(joinedload(User.domainName))

3. 序列化结果

使用 Flask-SQLAlchemy 的 to_dict 方法序列化结果：

data = data.to_dict()

示例代码

以下是一个使用 SQLAlchemy 和 Flask-SQLAlchemy 序列化父对象及其子对象的示例代码：

from flask_sqlalchemy import SQLAlchemy
from sqlalchemy import Join

db = SQLAlchemy()

class User(db.Model):
    __tablename__ = "user_account"

    email = db.Column(db.String(60), primary_key=True)
    username = db.Column(db.String(30))
    password = db.Column(db.BYTEA(60))
    firstname = db.Column(db.String(30))
    lastname = db.Column(db.String(30))

    domainName = db.relationship("DomainName", cascade="all, delete-orphan", backref="user_account")

class DomainName(db.Model):
    __tablename__ = "user_domain"
    domain_id = db.Column(db.Integer, primary_key=True)
    user_id = db.Column(db.ForeignKey("user_account.email"))
    domain_name = db.Column(db.String(30))

@app.route("/get_data")
def get_data():
    query = db.session.query(User).options(joinedload(User.domainName))
    data = query.first()
    return data.to_dict()