What is `related_name` used for in Django?

前端 未结 6 1479
长发绾君心
长发绾君心 2020-11-22 03:53

What is the related_name argument useful for on ManyToManyField and ForeignKey fields? For example, given the following code, what is

6条回答
  •  清歌不尽
    2020-11-22 04:30

    The related_name attribute specifies the name of the reverse relation from the User model back to your model.

    If you don't specify a related_name, Django automatically creates one using the name of your model with the suffix _set, for instance User.map_set.all().

    If you do specify, e.g. related_name=maps on the User model, User.map_set will still work, but the User.maps. syntax is obviously a bit cleaner and less clunky; so for example, if you had a user object current_user, you could use current_user.maps.all() to get all instances of your Map model that have a relation to current_user.

    The Django documentation has more details.

提交回复
热议问题