Opened 5 years ago

Closed 2 years ago

#19434 closed Bug (wontfix)

Some QuerySet methods not aware of fields added on "extra"

Reported by: Henrique C. Alves Owned by: nobody
Component: Database layer (models, ORM) Version: master
Severity: Normal Keywords: QuerySet.extra
Cc: flo@… Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: yes
Easy pickings: no UI/UX: no


Some examples to illustrate the issue:

(Pdb) CUSTOM_SQL = "SELECT some_function(some_field) FROM some_table"

# This works
(Pdb) qs = qs.extra(select={'some_alias': CUSTOM_SQL}, order_by=['some_alias'])

# This fails
(Pdb) qs.filter(some_alias__gt=0)
*** FieldError: Cannot resolve keyword 'some_alias' into field. Choices are: ...

# This works
(Pdb) qs.values()
[{'some_alias': 1}, {'some_alias': 2}]

# This fails
(Pdb) qs.values('some_alias')
*** FieldError: Cannot resolve keyword 'some_alias' into field. Choices are: ...

There's a situation where half of the API supports extra queries correctly, the other half fails with a FieldError, and there's no clear indication to what should be the right behavior.

Change History (8)

comment:1 Changed 5 years ago by Henrique C. Alves

Might be related to ticket #8784.

Last edited 5 years ago by Henrique C. Alves (previous) (diff)

comment:2 Changed 5 years ago by Aymeric Augustin

Triage Stage: UnreviewedAccepted

Yes, it isn't possible to filter on a field added in a .extra(select={...}). I've hit this problem too.

comment:3 Changed 4 years ago by fhahn

Cc: flo@… added
Has patch: set
Version: 1.4master

I've started a patch that adds support for filtering fields added by extra and created a pull request:

I think something similar has been done to provide support for filtering annotations/aggregations

qs.extra(select={'num_plus_one': 'num + 1'}

will result in following query:

SELECT (num+1) AS "num_plus_on" ... 
WHERE (num+1) = 2 ....

In order to avoid quoting of the lvalue of the term in the WHERE part I modified WhereNode.add to accept a QueryWrapper (contains the extra sql). There's probably a much better way to add an unqouted lvalue to the WhereNode, any suggestions/feedback are very appreciated.

qs.values('some_alias') worked for me (without modification), but I've added a test to check it.

comment:4 Changed 4 years ago by Tim Graham

Triage Stage: AcceptedReady for checkin

I've updated the patch with some cosmetic tweaks as well as to merge cleanly to master (confirmed all tests pass as well). Would like someone more familiar with the code to +1 before it gets committed.

Version 0, edited 4 years ago by Tim Graham (next)

comment:5 Changed 4 years ago by Tim Graham

Triage Stage: Ready for checkinAccepted

comment:6 Changed 4 years ago by Tim Graham

#21159 reported the inability to distinct() on extra columns.

comment:7 Changed 3 years ago by Tim Graham

Patch needs improvement: set

Patch no longer merges cleanly.

comment:8 Changed 2 years ago by Tim Graham

Keywords: QuerySet.extra added
Resolution: wontfix
Status: newclosed

We are no longer fixing bugs with QuerySet.extra() per discussion on django-developers.

Note: See TracTickets for help on using tickets.
Back to Top