Django Rest Framework ViewSet doesn't filter by field

Question

I have a ModelViewSet with SearchFilter and OrderingFilter. Everything works fine, but when I try to filter by one specific field (like localhost:8000:/es/countries/?code=MX), it returns all records even when only one matches the criteria. When I use a generic search, like localhost:8000:/es/countries/?search=MX, it works fine.

This is my ViewSet:

class CountryViewSet(viewsets.ModelViewSet):
    permission_classes = (permissions.IsAuthenticated,)
    queryset = models.Country.objects.all()
    serializer_class = serializers.CountrySerializer
    filter_backends = (DjangoFilterBackend, SearchFilter, OrderingFilter,)
    search_fields = ('name', 'code', 'calling_code')
    filter_fields = ('name', 'code', 'calling_code')

mrroot5 · Accepted Answer · 2019-05-12 19:20:20Z

3

You can use the DjangoFilterBakend.

In your code you are using search_fields, it only works with search param. (as it is for searching and for filtering!!)

You need to add DjangoFilterBackend same as you have added SearchFilter and OrderingFilter in filter_backends field. And then mention the filter that you want in filter_fields field.

For eg:

class CountryViewSet(viewsets.ModelViewSet):
   permission_classes = (permissions.IsAuthenticated,)
   queryset = models.Country.objects.all()
   serializer_class = serializers.CountrySerializer
   filter_backends = (SearchFilter, OrderingFilter, DjangoFilterBackend)
   search_fields = ('name', 'code', 'calling_code')
   filter_fields = ('name', 'code', 'calling_code')

You will also have to install django-filter.

pip install django-filter

Finally add django_filter to INSTALLED_APPS.

INSTALLED_APPS = [
    ....
    'django_filters',
]

edited May 12, 2019 at 19:20

mrroot5

2,0013 gold badges29 silver badges33 bronze badges

answered Jun 19, 2018 at 22:45

Harsh Bhikadia

11k10 gold badges53 silver badges73 bronze badges

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

2 Comments

HuLu ViCa Over a year ago

I followed your suggestion, but I got this error: django.template.exceptions.TemplateDoesNotExist: django_filters/rest_framework/form.html. Thanks for your help

Harsh Bhikadia Over a year ago

Add django_filters as INSTALLED_APPS for template rendering

Collectives™ on Stack Overflow

Django Rest Framework ViewSet doesn't filter by field

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related