Docs for related_query_name

This commit is contained in:
Andrew Godwin 2013-06-27 15:12:35 +01:00
parent b21e96d00d
commit 12cb0df10f
1 changed files with 22 additions and 0 deletions

View File

@ -1083,6 +1083,22 @@ define the details of how the relation works.
user = models.ForeignKey(User, related_name='+') user = models.ForeignKey(User, related_name='+')
.. attribute:: ForeignKey.related_query_name
.. versionadded:: 1.6
The name to use for the reverse filter name from the target model.
Defaults to the value of :attr:`related_name` if it is set, otherwise it
defaults to the name of the model::
# Declare the ForeignKey with related_query_name
class Tag(models.Model):
article = models.ForeignKey(Article, related_name="tags", related_query_name="tag")
name = models.CharField(max_length=255)
# That's now the name of the reverse filter
article_instance.filter(tag__name="important")
.. attribute:: ForeignKey.to_field .. attribute:: ForeignKey.to_field
The field on the related object that the relation is to. By default, Django The field on the related object that the relation is to. By default, Django
@ -1207,6 +1223,12 @@ that control how the relationship functions.
users = models.ManyToManyField(User, related_name='u+') users = models.ManyToManyField(User, related_name='u+')
referents = models.ManyToManyField(User, related_name='ref+') referents = models.ManyToManyField(User, related_name='ref+')
.. attribute:: ForeignKey.related_query_name
.. versionadded:: 1.6
Same as :attr:`ForeignKey.related_query_name`.
.. attribute:: ManyToManyField.limit_choices_to .. attribute:: ManyToManyField.limit_choices_to
Same as :attr:`ForeignKey.limit_choices_to`. Same as :attr:`ForeignKey.limit_choices_to`.