Skip to content

Commit

Permalink
Docs for related_query_name
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewgodwin committed Jun 27, 2013
1 parent b21e96d commit 12cb0df
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/ref/models/fields.txt
Expand Up @@ -1083,6 +1083,22 @@ define the details of how the relation works.

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

The field on the related object that the relation is to. By default, Django
Expand Down Expand Up @@ -1207,6 +1223,12 @@ that control how the relationship functions.
users = models.ManyToManyField(User, related_name='u+')
referents = models.ManyToManyField(User, related_name='ref+')

.. attribute:: ForeignKey.related_query_name

This comment has been minimized.

Copy link
@rosnfeld

rosnfeld Dec 13, 2013

Apologies if I have this wrong as I am new to Django, but this is a typo, right? (should be ManyToManyField.related_query_name ?)

This comment has been minimized.

Copy link
@andrewgodwin

andrewgodwin Dec 15, 2013

Author Member

You're right; I'll patch it. Thanks!


.. versionadded:: 1.6

Same as :attr:`ForeignKey.related_query_name`.

.. attribute:: ManyToManyField.limit_choices_to

Same as :attr:`ForeignKey.limit_choices_to`.
Expand Down

0 comments on commit 12cb0df

Please sign in to comment.