python - ORM 列可以在 SQLAlchemy 中触发 session 刷新吗？

Question

问题

属性访问可以触发 SQLAlchemy 中的 session 刷新吗？我的期望是，例如，通过 column_property() 或 @hybrid_property 附加到对象的查询会导致 session 自动刷新，就像通过 session.Query() 进行的查询一样。事实并非如此。

在下面的简单示例中，一个帐户包含一个条目集合。它还提供了一个“balance”属性，由 column_property() 构造，公开了一个选择和查询。只有在显式调用 session.flush() 时，新条目才会出现在帐户余额中。

这种行为似乎不是最理想的:Account 类的用户需要在了解余额实现的内部结构的基础上在他们的代码中散布 flush() 调用。如果实现发生变化——例如，如果“balance”之前是 Python @property——即使 Account 接口(interface)本质上相同，也会引入错误。有替代方案吗？

完整示例

import sys
import sqlalchemy as sa
import sqlalchemy.sql
import sqlalchemy.orm
import sqlalchemy.ext.declarative

Base = sa.ext.declarative.declarative_base()

class Entry(Base):
    __tablename__ = "entries"

    id = sa.Column(sa.Integer, primary_key=True)
    value = sa.Column(sa.Numeric, primary_key=True)
    account_id = sa.Column(sa.Integer, sa.ForeignKey("accounts.id"))
    account = sa.orm.relationship("Account", backref="entries")

class Account(Base):
    __tablename__ = "accounts"

    id = sa.Column(sa.Integer, primary_key=True)
    balance = sa.orm.column_property(
        sa.sql.select([sa.sql.func.sum(Entry.value)])
            .where(Entry.account_id == id)
        )

def example(database_url):
    # connect to the database and prepare the schema
    engine = sa.create_engine(database_url)
    session = sa.orm.sessionmaker(bind=engine)()

    Base.metadata.create_all(bind = engine)

    # add an entry to an account
    account = Account()

    account.entries.append(Entry(value = 42))

    session.add(account)

    # and look for that entry in the balance
    print "account.balance:", account.balance

    assert account.balance == 42

if __name__ == "__main__":
    example(sys.argv[1])

观察输出

$ python sa_column_property_example.py postgres:///za_test
account.balance: None
Traceback (most recent call last):
  File "sa_column_property_example.py", line 46, in <module>
    example(sys.argv[1])
  File "sa_column_property_example.py", line 43, in example
    assert account.balance == 42
AssertionError

首选输出

我希望看到“account.balance: 42”，而不添加对 session.flush() 的显式调用。

Answer 1

column_property 仅在查询时评估，即当您说查询(帐户)时，以及当属性过期时，即如果您说 session.expire("account", ['balance']) .

为了让一个属性每次都调用一个查询，我们使用了一个@property(这里有一些小的 mods 用于脚本与 sqlite 一起工作):

import sys
import sqlalchemy as sa
import sqlalchemy.sql
import sqlalchemy.orm
import sqlalchemy.ext.declarative

Base = sa.ext.declarative.declarative_base()

class Entry(Base):
    __tablename__ = "entries"

    id = sa.Column(sa.Integer, primary_key=True)
    value = sa.Column(sa.Numeric)
    account_id = sa.Column(sa.Integer, sa.ForeignKey("accounts.id"))
    account = sa.orm.relationship("Account", backref="entries")

class Account(Base):
    __tablename__ = "accounts"

    id = sa.Column(sa.Integer, primary_key=True)

    @property
    def balance(self):
        return sqlalchemy.orm.object_session(self).query(
                    sa.sql.func.sum(Entry.value)
                ).filter(Entry.account_id == self.id).scalar()

def example(database_url):
    # connect to the database and prepare the schema
    engine = sa.create_engine(database_url, echo=True)
    session = sa.orm.sessionmaker(bind=engine)()

    Base.metadata.create_all(bind = engine)

    # add an entry to an account
    account = Account()

    account.entries.append(Entry(value = 42))

    session.add(account)

    # and look for that entry in the balance
    print "account.balance:", account.balance

    assert account.balance == 42

if __name__ == "__main__":
    example("sqlite://")

请注意，“冲洗”本身通常不是我们需要担心的事情； autoflush 功能将确保每次 query() 进入数据库以获取结果时都会调用 flush，因此它确实确保了查询的发生，这正是我们想要的。

解决此问题的另一种方法是使用混合动力车。我建议阅读所有三种方法的概述，网址为 SQL Expressions as Mapped Attributes其中列出了每种方法的权衡。