How to query a JSONField comprising a list of values in DJANGO

Question

I am using JSONField to store the configuration parameter(user_types) as a list as follows:

["user_type1", "user_type2", "user_type3"]

How to query to filter elements of type "user_type1"? The following query is not working:

rows=ConfigUserTable.objects.filter(user_types__in=["user_type1"])

Thanks

Which DB backend are you using? – Iain Shelvington Apr 18 '21 at 13:08 — Iain Shelvington, Apr 18 '21 at 13:08

score 0 · Answer 1 · answered Jul 12 '21 at 02:17

Use the contains lookup, which is overridden on JSONField. For example, the following may work:

ConfigUserTable.objects.filter(user_types__contains="user_type1")

However, this might depend on how you are storing JSON data in the field. If you are storing the data as a dict, querying on that key will certainly work. I.e. data in this format in the field user_types:

{"types": ["user_type1", "user_type2", "user_type3"]}

could be queried like so:

ConfigUserTable.objects.filter(user_types__types__contains="user_type1")

Reference: https://docs.djangoproject.com/en/dev/topics/db/queries/#std:fieldlookup-jsonfield.contains

How to query a JSONField comprising a list of values in DJANGO

1 Answers1