sqlalchemy 按具有多个关系引用的模型过滤

sqlalchemy filtering by model which has multiple relation references

比如我有Parcel型号,其中有senderreceiver,都是Subject。 我正在尝试从特定发件人处获取包裹。我不想用Parcel.sender.has(),因为性能,我真正的table太大了。

来自 docs

Because has() uses a correlated subquery, its performance is not nearly as good when compared against large target tables as that of using a join.

这是一个完整的粘贴和-运行示例:

from sqlalchemy import create_engine, Column, Integer, Text, ForeignKey
from sqlalchemy.orm import sessionmaker, relationship
from sqlalchemy.ext.declarative.api import declarative_base
from sqlalchemy.orm.util import aliased

engine = create_engine('sqlite://')
Session = sessionmaker(bind=engine)
s = Session()

Base = declarative_base()


class Subject(Base):
    __tablename__ = 'subject'

    id = Column(Integer, primary_key=True)
    name = Column(Text)


class Parcel(Base):
    __tablename__ = 'parcel'

    id = Column(Integer, primary_key=True)
    sender_id = Column(Integer, ForeignKey('subject.id'))
    receiver_id = Column(Integer, ForeignKey('subject.id'))

    sender = relationship('Subject', foreign_keys=[sender_id], uselist=False, lazy='joined')
    receiver = relationship('Subject', foreign_keys=[receiver_id], uselist=False, lazy='joined')

    def __repr__(self):
        return '<Parcel #{id} {s} -> {r}>'.format(id=self.id, s=self.sender.name, r=self.receiver.name)


# filling database
Base.metadata.create_all(engine)
p = Parcel()
p.sender, p.receiver = Subject(name='Bob'), Subject(name='Alice')
s.add(p)
s.flush()


#
# Method #1 - using `has` method - working but slow
print(s.query(Parcel).filter(Parcel.sender.has(name='Bob')).all())

所以,我尝试通过别名关系加入和过滤,这引发了一个错误:

#
# Method #2 - using aliased joining - doesn't work
# I'm getting next error: 
#
# sqlalchemy.exc.InvalidRequestError: Could not find a FROM clause to join from.  
# Tried joining to <AliasedClass at 0x7f24b7adef98; Subject>, but got: 
# Can't determine join between 'parcel' and '%(139795676758928 subject)s'; 
# tables have more than one foreign key constraint relationship between them. 
# Please specify the 'onclause' of this join explicitly.
#
sender = aliased(Parcel.sender)
print(s.query(Parcel).join(sender).filter(sender.name == 'Bob').all())

我发现如果我用连接条件而不是关系指定模型,它将起作用。但最终 SQL 查询不是我所期望的:

print(
    s.query(Parcel)\
    .join(Subject, Parcel.sender_id == Subject.id)\
    .filter(Subject.name == 'Bob')
)

生成下一个 SQL 查询:

SELECT parcel.id AS parcel_id,
       parcel.sender_id AS parcel_sender_id,
       parcel.receiver_id AS parcel_receiver_id,
       subject_1.id AS subject_1_id,
       subject_1.name AS subject_1_name,
       subject_2.id AS subject_2_id,
       subject_2.name AS subject_2_name
FROM parcel
JOIN subject ON parcel.sender_id = subject.id
LEFT OUTER JOIN subject AS subject_1 ON subject_1.id = parcel.sender_id
LEFT OUTER JOIN subject AS subject_2 ON subject_2.id = parcel.receiver_id
WHERE subject.name = ?

在这里您可以看到 subject table 被连接了三次而不是两次。那是因为 senderreceiver 关系都配置为加载连接。第三个连接是我过滤的主题。

我希望最终查询如下所示:

SELECT parcel.id AS parcel_id,
       parcel.sender_id AS parcel_sender_id,
       parcel.receiver_id AS parcel_receiver_id,
       subject_1.id AS subject_1_id,
       subject_1.name AS subject_1_name,
       subject_2.id AS subject_2_id,
       subject_2.name AS subject_2_name
FROM parcel
LEFT OUTER JOIN subject AS subject_1 ON subject_1.id = parcel.sender_id
LEFT OUTER JOIN subject AS subject_2 ON subject_2.id = parcel.receiver_id
WHERE subject_1.name = ?

我相信通过多个引用关系进行过滤不应该这么不清楚,并且有更好更清晰的方法来做到这一点。请帮我找一下。

您已将其配置为 senderreciever 将始终通过连接加载。
当您实际上需要通过连接同时加载它们时,您可以更改它并手动执行 joinedload

如果您希望保留原样的定义,您可以 "help" SQLAlchemy 并指出该查询已经具有用于此比较的所有数据,因此不需要一个额外的加入。为此,使用 contains_eager 选项。

修改后的查询:

q = (s.query(Parcel)
     .join(Parcel.sender)
     .options(contains_eager(Parcel.sender))
     .filter(Subject.name == 'Bob'))

并且SQL它产生:

SELECT subject.id AS subject_id,
       subject.name AS subject_name,
       parcel.id AS parcel_id,
       parcel.sender_id AS parcel_sender_id,
       parcel.receiver_id AS parcel_receiver_id,
       subject_1.id AS subject_1_id,
       subject_1.name AS subject_1_name
FROM parcel
JOIN subject ON subject.id = parcel.sender_id
LEFT OUTER JOIN subject AS subject_1 ON subject_1.id = parcel.receiver_id
WHERE subject.name = ?