防止 ORM 关系中的重复子条目答案

【问题标题】：Preventing duplicate child entries in an ORM relationship防止 ORM 关系中的重复子条目
【发布时间】：2021-10-19 12:36:14
【问题描述】：

基本上我有一个从电子表格读取并插入数据库的服务。在 SQLAlchemy 中我有以下关系

class Customer(Base):
 __tablename__ = 'customers'
 id = Column(Integer, primary_key=True)
 name = Column(String)
 children = relationship('Email', backref=('customer')

class Email(Base):
 __tablename__ = 'emails'
 id = Column(Integer, primary_key=True)
 customer = Column(Integer, ForeignKey('customer.id')) 
 email = Column(String)
 primary = Column(Boolean)

SQLAlchemy 是否可以检查获取的资源和在 ORM 中创建的资源之间的重复条目？例如，假设客户 123 有一封电子邮件 some_email，我们尝试再次添加：

email_object = Email(customer=123, email='some_email', primary=True)
cust = connection.query(Customer).options(joinedload(Customer.emails)).filter_by(
        id=123).first()
cust.emails.append(email_object)

理想情况下，我希望 SQLAlchemy 注意到这样的组合存在并合并/忽略它，或者抛出某种异常。

但是，如果我打印出cust.emails，则会得到以下结果

[<Email(id=1, email=some_email, primary=True, customer=123>), 
<Email(customer=192071, email='some_email', primary=True, customers=<Employee(id=123, name='John', emails=['some_email', 'some_email']>>)]

并进行合并和提交似乎只是在数据库中添加了一个额外的相同行（pk 除外）。我认为这可能与电子邮件中未使用的主键有关，但这是在提交到数据库时自动生成的。有任何想法吗？让我知道是否需要澄清任何事情。

【问题讨论】：

您的电子邮件对象可以使用 (customer, email) 作为其主键，而不是整数自动增量值。这样可以防止同一客户的电子邮件地址重复。
@GordThompson 您的意思是在数据库级别？这可以阻止数据被复制，但这意味着我只知道提交事务时它何时抛出。将 Email 类设置为具有两个主键似乎不会使 SQLAlchemy 停止将额外的电子邮件附加到 cust.emails。我应该使用其他操作吗？

标签： python sqlalchemy orm

【解决方案1】：

将 Email 类设置为具有两个主键似乎不会使 SQLAlchemy 停止附加额外的电子邮件

没错。在 (customer_id, email) 上使用复合主键并不会阻止 SQLAlchemy 尝试插入一个基本上复制现有电子邮件的新对象 - 尽管它会警告您是否已经有具有相同主键的对象存在于身份映射中 - 由于重复的 PK，INSERT 将失败（抛出异常并回滚），从而防止重复的子记录。

如果您想在尝试添加之前检查电子邮件是否存在，您可以使用session.get() ...

with Session(engine) as session:
    # retrieve John's object
    john = (
        session.execute(select(Customer).where(Customer.name == "John"))
        .scalars()
        .one()
    )
    print(john)  # <Customer(id=123, name='John')>

    # check if email already exists using .get()
    email = session.get(Email, (john.id, "some_email"))
    if email:
        print(f"email already exists: {email}")
        # email already exists: <Email(customer_id=123, email='some_email')>
    else:
        print("email does not already exist")

…或者客户中的关系可以提供现有的电子邮件，允许您搜索要添加的电子邮件

    # alternative (less efficient) method: check via relationship
    e_list = [e for e in john.emails if e.email == "some_email"]
    if e_list:  # list not empty
        print("email already exists")
    else:
        print("email does not already exist")

【讨论】：