When do I need to use sqlalchemy back_populates?

by

If you use backref you don’t need to declare the relationship on the second table.

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'))

If you’re not using backref, and defining the relationship‘s separately, then if you don’t use back_populates, sqlalchemy won’t know to connect the relationships, so that modifying one also modifies the other.

So, in your example, where you’ve defined the relationship‘s separately, but didn’t provide a back_populates argument, modifying one field wouldn’t automatically update the other in your transaction.

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

See how it didn’t automatically fill out the children field?

Now, if you supply a back_populates argument, sqlalchemy will connect the fields.

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")

So now we get

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

Sqlalchemy knows these two fields are related now, and will update each as the other is updated. It’s worth noting that using backref will do this, too. Using back_populates is nice if you want to define the relationships on every class, so it’s easy to see all the fields just be glancing at the model class, instead of having to look at other classes that define fields via backref.

More Related Contents:

  1. SQLAlchemy create_all() does not create tables
  2. SQL Alchemy ORM returning a single column, how to avoid common post processing
  3. How do I execute inserts and updates in an Alembic upgrade script?
  4. Python call sql-server stored procedure with table valued parameter
  5. Generate sql with subquery as a column in select statement using SQLAlchemy
  6. Bulk insert with SQLAlchemy ORM
  7. How can I verify Column data types in the SQLAlchemy ORM?
  8. Updates to JSON field don’t persist to DB
  9. Complex foreign key constraint in SQLAlchemy
  10. ImportError: No module named MySQLdb
  11. Connection problems with SQLAlchemy and multiple processes
  12. How to upsert pandas DataFrame to Microsoft SQL Server table?
  13. How do I select literal values in an sqlalchemy query?
  14. SQLAlchemy: engine, connection and session difference
  15. Relations on composite keys using sqlalchemy
  16. flake8 complains on boolean comparison “==” in filter clause
  17. SQLAlchemy – Mapping self-referential relationship as one to many (declarative form)
  18. Setting SQLAlchemy autoincrement start value
  19. Getting random row through SQLAlchemy
  20. Select NULL Values in SQLAlchemy
  21. How to delete a table in SQLAlchemy?
  22. sqlalchemy existing database query
  23. How to get number of affected rows in sqlalchemy?
  24. Flask-SQLAlchemy Constructor
  25. convert selected datetime to date in sqlalchemy
  26. ImportError: cannot import name ‘_ColumnEntity’ from ‘sqlalchemy.orm.query’
  27. Is possible to mapping view with class using mapper in SqlAlchemy?
  28. How to prevent UUID primary key for new SQLAlchemy objects being created with the same value
  29. SQLALchemy dynamic filter_by
  30. SQLAlchemy ordering by count on a many to many relationship

Leave a Comment