django rest framework queryset doesn't order

Question

i use model with Meta ordering = ['-published_date']

Now in view:

class InvoiceViewSet(viewsets.ModelViewSet):
    queryset = Invoice.objects.all()
    serializer_class = InvoiceSerializer
    filter_fields = ('table',)

And serializer:

class InvoiceSerializer(serializers.ModelSerializer):
    items = ItemSerializer(many=True, allow_add_remove=True)

    class Meta:
        model = Invoice
        fields = ('id',  'items', 'table', 'published_date')

But this ordering doesn't work, it shows me ordering ASC, and i need DESC, it doesn't affect order at all.

What am i doing wrong?

if your call Invoice.objects.all() from the shell does it show DESC ordering? — agconti
– agconti, Commented Jul 28, 2014 at 1:43
it must be somthing with DRF. what does your output look like? — agconti
– agconti, Commented Jul 28, 2014 at 2:09
I used rest client to see output, it just order it ASC. Can something be wrong with view, or serializer? Or is there any other way to do this? — Mirza Delic
– Mirza Delic, Commented Jul 28, 2014 at 2:36
you can override the get_queryset() method but, ive done this before just like you and its worked for me. Somehting else must be wrong. — agconti
– agconti, Commented Jul 28, 2014 at 2:47

Tom Christie · Accepted Answer · 2014-07-28 11:23:33Z

34

If your model does have an ordering it really will be reflected in the list view by default. I'd suggest overriding get_queryset() and debugging the return result there, or else explicitly adding the ordering to the queryset.

For example:

queryset = Invoice.objects.all().order_by('-published_date')

Wondering if it's possible you've configured a filter that's overriding the ordering. Worth testing what happens if you turn all filters off. I see you have the filter_fields attribute set, so assuming you've got something like this in your settings...

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': ('rest_framework.filters.DjangoFilterBackend',)
}

If you comment that out does that fix things?

answered Jul 28, 2014 at 11:23

Tom Christie

34k7 gold badges104 silver badges87 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Mirza Delic Over a year ago

It works when i comment this. Thanks, now can i make it work together?

Tom Christie Over a year ago

The easy fix should be the .order_by listed above, but next step - why does using DjangoFilterBackend set an explicit ordering, instead of leaving the default? Is that a bug in django-filter or an integration issue in REST framework?

Mirza Delic Over a year ago

It still doesn't work when use queryset = Invoice.objects.all().order_by('-published_date') :(

Tom Christie Over a year ago

Okay interesting, assuming that django-filter overrides the ordering then. Ticket is github.com/tomchristie/django-rest-framework/issues/1717

Adrian Martin · Accepted Answer · 2019-08-22 13:23:35Z

32

For Django REST Framework you can use OrderingFilter.

from django_filters import DjangoFilterBackend
from rest_framework import viewsets, filters


class InvoiceViewSet(viewsets.ModelViewSet):
    queryset = Invoice.objects.all()
    serializer_class = InvoiceSerializer

    filter_backends = (DjangoFilterBackend, filters.OrderingFilter)

    # Explicitly specify which fields the API may be ordered against
    ordering_fields = ('items', 'table', 'published_date')

    # This will be used as the default ordering
    ordering = ('-published_date')

edited Aug 22, 2019 at 13:23

Adrian Martin

2,3732 gold badges21 silver badges22 bronze badges

answered Jul 3, 2019 at 20:34

shiva reddy

4674 silver badges10 bronze badges

3 Comments

David Dolan Over a year ago

For anyone thats banging their head on ordering via a query param manually in DRF, this solved a couple hour headache in minutes.Thank you!

Mazhar Ali Over a year ago

If anyone's using django-filters and can't use another backend. See my answer below.

batero Over a year ago

this explanation is pretty useful. Worth to mention that the import of filters.OrderingFilter must be from rest_framework instead of django_filters. This will may help to reduce hours of unnecessary headache, like the ones that I had

Mirza Delic · Accepted Answer · 2017-04-26 13:30:24Z

24

Solution is to override filter_queryset:

def filter_queryset(self, queryset):
    queryset = super(InvoiceViewSet, self).filter_queryset(queryset)
    return queryset.order_by('-published_date')

edited Apr 26, 2017 at 13:30

answered Jul 29, 2014 at 12:32

Mirza Delic

4,38112 gold badges59 silver badges88 bronze badges

1 Comment

Matt Over a year ago

That's a lot of overhead for a simple feature. I wonder if this has changed in the last 4.5 years?

EdgarT · Accepted Answer · 2015-04-04 21:31:30Z

7

@Mirza Delic answer works but does not keep the ordering comming from request.QUERY_PARAMS.

class YOUR_VIEW_SET(viewsets.ModelViewSet):
    #your code here
    ordering_filter = OrderingFilter()

    def filter_queryset(self, queryset):
        queryset = super(YOUR_VIEW_SET, self).filter_queryset(queryset)
        return self.ordering_filter.filter_queryset(self.request, queryset, self)

This works for me and for other people I hope.

edited Apr 4, 2015 at 21:31

answered Apr 4, 2015 at 3:38

EdgarT

1,0881 gold badge11 silver badges18 bronze badges

Comments

Mazhar Ali · Accepted Answer · 2021-11-24 14:55:20Z

If anyone's coming here from google for 'How to order django-filters queryset'.

There's OrderingFilter in django-filters, which you can use to add the order_by functionality. The example code from the docs looks like this :

class UserFilter(FilterSet):
account = CharFilter(field_name='username')
status = NumberFilter(field_name='status')

o = OrderingFilter(
    # tuple-mapping retains order
    fields=(
        ('username', 'account'),
        ('first_name', 'first_name'),
        ('last_name', 'last_name'),
    ),

    # labels do not need to retain order
    field_labels={
        'username': 'User account',
    }
)

class Meta:
    model = User
    fields = ['first_name', 'last_name']

Where o is the name of the query param. So if you hit www.domain.com/o=username. It will return the queryset ordered by username. If you want to order_by in descending order. Just do www.domain.com/o=-username (notice the - before username).

Collectives™ on Stack Overflow

django rest framework queryset doesn't order

5 Answers 5

4 Comments

3 Comments

1 Comment

Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

4 Comments

3 Comments

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related