rsinger86 / drf-flex-fields

Dynamically set fields and expand nested resources in Django REST Framework serializers.
MIT License
736 stars 61 forks source link

Does "deferred field" imply under-the-hood `.defer()`? #136

Open danlynkew opened 11 months ago

danlynkew commented 11 months ago

Django provides the .defer() optimization for querysets. This optimization drops the deferred field from the SQL query sent to the database. That is, Country.objects.first().defer('states') means "don't even ask the database for the country's states field."

drf-flex-fields's documentation reads:

Alternatively, you could treat country as a "deferred" field by not defining it among the default fields. To make a field deferred, only define it within the serializer's expandable_fields.

When drf-flex-fields is used to "defer" a field in this way, is Django's .defer() actually used under the hood?

Asked another way: will the default response for the below serializer retrieve a country's states field from the database or not?

class CountrySerializer(FlexFieldsModelSerializer):
    class Meta:
        model = Country
        fields = ['name', 'population']

        expandable_fields = {
            'states': (StateSerializer, {'many': True})
        }
danlynkew commented 10 months ago

@rsinger86

Caiofcas commented 3 months ago

No, it does not use django's .defer(), it only means that it will not return that field in the serializer answer. You can confirm that by searching the source code : https://github.com/search?q=repo%3Arsinger86%2Fdrf-flex-fields%20defer&type=code

I know this question is a bit old but leaving it here for posterity.