Turn off automatic pagination of Django Rest Framework ModelViewSet

Question

I am using Django Rest Framework's ModelViewSet for one of my views. ModelViewSet uses the ListModelMixin which automatically paginates the results but I do not want the results paginated. In my API call I say how many results I want returned but as it stands I can't get back more than 10 results in one call.

Is there a way to turn off the automatic pagination and so I can have as many results as I want returned?

ListModelMixing is very simple, (https://github.com/tomchristie/django-rest-framework/blob/bb56ca46ed6c07db0146dbdc61c672ff25f127de/rest_framework/mixins.py) Looks like you could write your own mixin and just omit the lines that do the pagination. — PhoebeB, Apr 11 '16 at 16:26
I haven't found an easy way to turn pagination off exactly but I was able to set PAGE_SIZE in the REST_FRAMEWORK settings to a large number to allow me to get more results returned. — Bill Noble, Apr 11 '16 at 16:41

trinchet · Accepted Answer · 2022-12-04T16:58:07.620

118

If you are using recent versions of DRF you just need to add pagination_class = None to your ModelViewSet definition.

class MyClassBasedView(ModelViewSet):
    pagination_class = None
    ...

You can also see some tips here https://github.com/tomchristie/django-rest-framework/issues/1390

edited Dec 04 '22 at 16:58

answered Apr 11 '16 at 20:24

trinchet

6,753
4
37
60

5

but that removes `results` attribute – ospider Dec 16 '18 at 13:01
@ospider why is he needed? – Alex78191 Oct 25 '19 at 01:50
Sometimes you want to use the same viewset for both options. In those cases overwrite paginate_queryset method. – jplattus Nov 10 '21 at 18:29

score 15 · Answer 2 · edited Aug 26 '21 at 02:45

15

ModelViewSet or mixins.ListModelMixin automatically create pagination for us. You can stop it by paginator = None

class NotesViewSet(viewsets.ModelViewSet):    
     queryset = Notes.objects.all()
     serializer_class = NotesWriteSerializer
     paginator = None

edited Aug 26 '21 at 02:45

Andrei Savin

2,350
4
26
40

answered Dec 07 '17 at 18:19

Gautam Kumar

1,385
14
17

score 4 · Answer 3 · answered Aug 16 '20 at 05:08

And if you want paginator disabled for just one action:

@property
def paginator(self):
    self._paginator = super(NotesViewSet, self).paginator
    if self.action == 'the_action_you_want_pagination_disabled':
        self._paginator = None
    return self._paginator

use this in your ModelViewSet.

Ricardo D. Quiroga · Answer 4 · 2021-03-22T20:57:51.383

3

In settings.py for global

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': None,
    'PAGE_SIZE': 99999999, # a very large number
}

edited Mar 22 '21 at 20:57

answered Sep 20 '20 at 16:44

Ricardo D. Quiroga

170
7

Enoque · Answer 5 · 2023-06-03T13:46:59.993

You can use a large number of items for specific view, keeping the results attribute and default pagination number for all others views, using a custom Pagination Class like this:

from rest_framework import pagination, permissions, viewsets


class FooViewSet(viewsets.ReadOnlyModelViewSet):
   class CustomFooPagination(pagination.PageNumberPagination):
      page_size = 10000

   pagination_class = CustomFooPagination
   queryset = FooModel.objects.filter(enabled=True)
   serializer_class = FooSerializer
   permission_classes = [permissions.IsAuthenticated]

Umar Asghar · Answer 6 · 2023-06-13T12:37:28.083

It can be done via two way either one you like or choose for you

Paginator Property

class MyClassBasedView(ModelViewSet):
    pagintor = None

Paginatior Class

class MyClassBasedView(ModelViewSet):
    pagination_class = None

Details about why we use methods

Reason of using these ways because the ModelViewSet class inherits GenericView that inherits GenericAPIView.

pagination class is a property of GenericAPIView that can be used to set pagination class or None for no pagination

Reference: https://github.com/encode/django-rest-framework/blob/aed7761a8d7e1691a4f4bbf9c83a447dac44d92a/rest_framework/generics.py#L158

paginator is also a property of GenericAPIView that can be used to set paginator class or None for no pagination

Reference: https://github.com/encode/django-rest-framework/blob/master/rest_framework/generics.py#L46

https://github.com/encode/django-rest-framework/blob/master/rest_framework/viewsets.py

Turn off automatic pagination of Django Rest Framework ModelViewSet

6 Answers6

Linked