Output Django queryset as JSON

by

You can use JsonResponse with values. Simple example:

from django.http import JsonResponse

def some_view(request):
    data = list(SomeModel.objects.values())  # wrap in list(), because QuerySet is not JSON serializable
    return JsonResponse(data, safe=False)  # or JsonResponse({'data': data})

Or another approach with Django’s built-in serializers:

from django.core import serializers
from django.http import HttpResponse

def some_view(request):
    qs = SomeModel.objects.all()
    qs_json = serializers.serialize('json', qs)
    return HttpResponse(qs_json, content_type="application/json")

In this case result is slightly different (without indent by default):

[
    {
        "model": "some_app.some_model",
        "pk": 1,
        "fields": {
            "name": "Elon",
            "age": 48,
            ...
        }
    },
    ...
]

I have to say, it is good practice to use something like marshmallow to serialize queryset.

…and a few notes for better performance:

  • use pagination if your queryset is big;
  • use objects.values() to specify list of required fields to avoid serialization and sending to client unnecessary model’s fields (you also can pass fields to serializers.serialize);

More Related Contents:

  1. How to output Django queryset as JSON?
  2. In a Django form, how do I make a field readonly (or disabled) so that it cannot be edited?
  3. django 1.5 – How to use variables inside static tag
  4. Difference between Django’s filter() and get() methods
  5. Best practice for Django project working directory structure [closed]
  6. How can I test https connections with Django as easily as I can non-https connections using ‘runserver’?
  7. Django – Circular model import issue
  8. Prevent Django SQLite db from being overwritten while pushing to Heroku
  9. The right place to keep my signals.py file in a Django project
  10. How do you use the django-filter package with a list of parameters?
  11. Django Rest Framework with ChoiceField
  12. django – why is the request.POST object immutable?
  13. Heroku – Handling static files in Django app
  14. django – get() returned more than one topic
  15. Django – Where are the params stored on a PUT/DELETE request?
  16. django: Purpose of django.utils.functional.SimpleLazyObject?
  17. Django, request.user is always Anonymous User
  18. Django migration error :you cannot alter to or from M2M fields, or add or remove through= on M2M fields
  19. Django CSRF framework cannot be disabled and is breaking my site
  20. Django accessing ManyToMany fields from post_save signal
  21. django filter older than day(s)?
  22. Django: What are the best practices to migrate a project from sqlite to PostgreSQL
  23. Open the file in universal-newline mode using the CSV Django module
  24. Django comparing model instances for equality
  25. Django {{ MEDIA_URL }} blank @DEPRECATED
  26. send_mass_emails with EmailMultiAlternatives
  27. How can I correctly set DJANGO_SETTINGS_MODULE for my Django project (I am using virtualenv)?
  28. Using AuthenticationForm in Django
  29. Django: __in query lookup doesn’t maintain the order in queryset
  30. Django self-recursive foreignkey filter query for all childs

Leave a Comment