Opened 7 years ago

Last modified 6 years ago

#29148 closed New feature

Explain how to use QuerySet.get_or_create() with Q objects — at Version 1

Reported by: Mike Lissner Owned by: nobody
Component: Documentation Version: 2.0
Severity: Normal Keywords:
Cc: Dhruv Singh, Herbert Fortes Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: yes UI/UX: no

Description (last modified by Tim Graham)

This technique is useful if you want to use Q objects in conjunction with the get or create method, and it's documented in a few places around the web.

I brought this up in the forums yesterday and somebody suggested that it be documented:

https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/django-developers/e3sJ6OiHEd0/Yrg-Z9uRAgAJ

I gave this a try, but I don't understand the documentation system and I sadly don't have time to figure it out. Seems though like a change could go here:

https://github.com/django/django/blob/master/docs/ref/models/querysets.txt#L1886

I think something along the lines of:

get_or_create() can be used with Q objects by chaining them together like so:

An example

When this is done, the logic performs as above, but matches are made according to the query in the Q object.

I imagine this also works for update_or_create, but I'm not sure how to document that too. Maybe just a quick mention:

update_or_create() can be used with Q objects using the same technique as documented above for get_or_create()

Change History (1)

comment:1 by Tim Graham, 7 years ago

Description: modified (diff)
Summary: Add filter().get_or_create() chaining to documentation to explain how to use get_or_create with Q objectsExplain how to use QuerySet.get_or_create() with Q objects
Triage Stage: UnreviewedAccepted
Note: See TracTickets for help on using tickets.
Back to Top