Коли мені потрібно використовувати sqlalchemy back_populates?

Question 1

Коли я пробую SQLAlchemy Relation Example, дотримуючись цього посібника: Основні зв’язки

У мене є цей код

#!/usr/bin/env python
# encoding: utf-8
from sqlalchemy import create_engine
from sqlalchemy import Table, Column, Integer, ForeignKey
from sqlalchemy.orm import relationship, sessionmaker
from sqlalchemy.ext.declarative import declarative_base

engine = create_engine('sqlite:///:memory:', echo=True)
Session = sessionmaker(bind=engine)
session = Session()
Base = declarative_base(bind=engine)

class Parent(Base):
    __tablename__ = 'parent'
    id = Column(Integer, primary_key=True)
    children = relationship("Child")

class Child(Base):
    __tablename__ = 'child'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('parent.id'))
    parent = relationship("Parent")

Base.metadata.create_all()

p = Parent()
session.add(p)
session.commit()
c = Child(parent_id=p.id)
session.add(c)
session.commit()
print "children: {}".format(p.children[0].id)
print "parent: {}".format(c.parent.id)

Це працює добре, але в керівництві сказано, що модель має бути такою:

class Parent(Base):
    __tablename__ = 'parent'
    id = Column(Integer, primary_key=True)
    **children = relationship("Child", back_populates="parent")**

class Child(Base):
    __tablename__ = 'child'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('parent.id'))
    **parent = relationship("Parent", back_populates="children")**

Чому мені не потрібно back_populatesчи backrefна моєму прикладі? Коли слід використовувати той чи інший?

Question 2

Якщо ви використовуєте, backrefвам не потрібно оголошувати зв’язок у другій таблиці.

class Parent(Base):
    __tablename__ = 'parent'
    id = Column(Integer, primary_key=True)
    children = relationship("Child", backref="parent")

class Child(Base):
    __tablename__ = 'child'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('parent.id'))

Якщо ви не використовуєте backrefта не визначаєте relationshipокремо, тоді, якщо ви не використовуєте back_populates, sqlalchemy не знатиме, щоб зв'язати відносини, так що модифікація одного також змінює інший.

Отже, у вашому прикладі, коли ви визначили relationshipокремо, але не вказали back_populatesаргумент, зміна одного поля не призведе до автоматичного оновлення іншого у вашій транзакції.

>>> parent = Parent()
>>> child = Child()
>>> child.parent = parent
>>> print(parent.children)
[]

Подивіться, як це не заповнило childrenполе автоматично?

Тепер, якщо ви back_populatesнадасте аргумент, sqlalchemy зв’яже поля.

class Parent(Base):
    __tablename__ = 'parent'
    id = Column(Integer, primary_key=True)
    children = relationship("Child", back_populates="parent")

class Child(Base):
    __tablename__ = 'child'
    id = Column(Integer, primary_key=True)
    parent_id = Column(Integer, ForeignKey('parent.id'))
    parent = relationship("Parent", back_populates="children")

Отже, тепер ми отримуємо

>>> parent = Parent()
>>> child = Child()
>>> child.parent = parent
>>> print(parent.children)
[Child(...)]

Sqlalchemy знає, що ці два поля пов'язані зараз, і буде оновлювати кожне, коли інше оновлюється. Варто зазначити, що використання backrefтеж зробить це. Використовувати back_populatesприємно, якщо ви хочете визначити відносини для кожного класу, тому легко бачити, що всі поля просто дивляться на клас моделі, замість того, щоб дивитися на інші класи, які визначають поля за допомогою зворотного посилання.