ModelAdmin.queryset() is undocumented.

[mrts]

However, it is extremely useful and advocated by e.g. James in ​http://www.b-list.org/weblog/2008/dec/24/admin/ .

[mrts]

Tentatively pushing to 1.1, feel free to push to 1.2.

[mrts]

Ideally, the following use cases would be documented:

• show only objects owned by the logged-in user (by James):

  def queryset(self, request):
      if request.user.is_superuser:
          return Entry.objects.all()
      return Entry.objects.filter(author=request.user)
  

• defer large fields that would otherwise slow down the changelist view and cause it to consume memory (#10710 needs to be fixed for this to work):

     def queryset(self, request):
         qs = super(...).queryset(request)
         return qs.only('list_display_field_1', 'list_display_field_2').select_related().only('related__field_used_in_string_representation')
  

[mrts]

The second use-case should wait for #10742 and #10733.

The proper incantation should actually be in the lines of the following:

class C(Base):
    name = models.CharField(max_length=10)
    is_published = models.BooleanField() 
    a = models.ForeignKey(A, blank=True, null=True)
    b = models.ForeignKey(B)

class CAdmin(admin.ModelAdmin):
    list_display = ('name', 'a', 'b', 'is_published')
    list_select_related = None

    def queryset(self, request):
        qs = super(CAdmin, self).queryset(request)
        return qs.only('name', 'is_published', 'a__name', 'b__name').select_related('a', 'b') 

[Tim Graham]

document case #1

[Ramiro Morales]

See also #12642.

[Tim Graham]

would be nice to get this in 1.2 if possible, the second use case above should probably be broken off to a separate ticket

[Russell Keith-Magee]

(In [13170]) Fixed #10712 -- Added documentation for the queryset() method on ModelAdmin. Thanks to mrts for the report, and timo for the patch.

[Russell Keith-Magee]

(In [13176]) [1.1.X] Fixed #10712 -- Added documentation for the queryset() method on ModelAdmin. Thanks to mrts for the report, and timo for the patch.

Backport of r13170 from trunk.

[Jacob]

Milestone 1.2 deleted