Filtering ArrayField

[sassanh]

Is it possible to filter fields defined in django.contrib.postgres.fields like ArrayField?

[rpkilby]

django-filter currently doesn't have any filters compatible with the postgres contrib fields - you would need to create your own. It will be more or less difficult depending on what you're trying to do. Supporting the custom lookups for ArrayField would be fairly trivial:

class CharArrayFilter(filters.BaseCSVFilter, filters.CharFilter):
     pass

class MyFilterSet(filters.FilterSet):
    tags__contains = CharArrayFilter(name='tags', lookup_expr='contains')

    class Meta:
        model = SomethingTaggable

GET http://localhost/api/something-taggable?tags__contains=a,b,c

The above filter will validate the comma-separated inputs and return a list of cleaned values, which is suitable for the underlying .filter() call.

On the other hand, it's a little more complicated to handle the index and slice transforms, which are unstructured and have a theoretically infinite amount of combinations.

[sassanh]

Thanks for info.

[carltongibson]

I'm going to close this as Out of Scope for the moment. Happy to consider documented, tested pull requests. We may have capacity to reconsider in the future.

[Is0MerLNtaLt]

Update:
Parameter name has been renamed to field_name so the MyFilterSet should look like:

class MyFilterSet(filters.FilterSet):
    tags__contains = CharArrayFilter(field_name='tags', lookup_expr='contains')

    class Meta:
        model = SomethingTaggable