feat: new InfinitePaginator for large tables (#1169)

Author: lukasvinclav

docs/configuration/paginator.md

@@ -0,0 +1,33 @@
+---
+title: Paginator
+order: 4
+description: Learn how to optimize performance for large datasets in Django Unfold admin using the custom InfinitePaginator that avoids expensive COUNT operations.
+---
+
+
+# Paginator
+
+Django Unfold provides a specialized paginator called `InfinitePaginator` designed specifically for handling large datasets efficiently. When working with tables containing millions of records, standard Django pagination can become slow due to expensive `COUNT` queries that calculate the total number of records.
+
+## InfinitePaginator
+
+The `InfinitePaginator` offers several advantages for large dataset management:
+
+- Eliminates expensive `COUNT` operations on the database
+- Displays simplified navigation with only "Previous" and "Next" links
+- Removes the upper limit on page numbers
+- Significantly improves performance for very large tables
+
+## Implementation
+
+To use the `InfinitePaginator` in your admin interface, simply configure your ModelAdmin class as follows:
+
+```python
+from unfold.admin import ModelAdmin
+from unfold.paginator import InfinitePaginator
+
+
+class YourAdmin(ModelAdmin):
+    paginator = InfinitePaginator
+    show_full_result_count = False
+```

src/unfold/paginator.py

@@ -0,0 +1,10 @@
+from django.core.paginator import Paginator
+from django.utils.functional import cached_property
+
+
+class InfinitePaginator(Paginator):
+    template_name = "unfold/helpers/pagination_infinite.html"
+
+    @cached_property
+    def count(self):
+        return 9_999_999_999

src/unfold/templates/admin/pagination.html

@@ -4,28 +4,12 @@
     <div class="{% if not is_popup %}max-w-full lg:bottom-0 lg:fixed lg:left-0 lg:right-0{% endif %}" {% if not is_popup %}x-bind:class="{'xl:left-0': !sidebarDesktopOpen, 'xl:left-72': sidebarDesktopOpen}"{% endif %} x-bind:style="'width: ' + mainWidth + 'px'">
         <div class="lg:backdrop-blur-sm lg:bg-white/80 lg:flex lg:items-center lg:dark:bg-base-900/80 {% if not is_popup %}lg:border-t lg:border-base-200 lg:h-[71px] lg:py-2 lg:relative lg:scrollable-top lg:px-8 lg:dark:border-base-800{% endif %}">
             <div class="flex flex-row items-center {% if not cl.model_admin.list_fullwidth %}lg:mx-auto{% endif %}" x-bind:style="'width: ' + changeListWidth + 'px'">
-                {% if pagination_required %}
-                    {% for i in page_range %}
-                        <div class="{% if forloop.last %}pr-2{% else %}pr-4{% endif %}">
-                            {% paginator_number cl i %}
-                        </div>
-                    {% endfor %}
+                {% if cl.paginator.template_name %}
+                    {% include cl.paginator.template_name %}
+                {% else %}
+                    {% include "unfold/helpers/pagination_default.html" %}
                 {% endif %}
 
-                <div class="py-4">
-                    {% if pagination_required %}
-                        -
-                    {% endif %}
-
-                    {{ cl.result_count }}
-
-                    {% if cl.result_count == 1 %}
-                        {{ cl.opts.verbose_name }}
-                    {% else %}
-                        {{ cl.opts.verbose_name_plural }}
-                    {% endif %}
-                </div>
-
                 {% if show_all_url %}
                     <a href="{{ show_all_url }}" class="showall ml-4 text-primary-600 dark:text-primary-500">
                         {% translate 'Show all' %}

src/unfold/templates/unfold/helpers/pagination_default.html

@@ -0,0 +1,23 @@
+{% load unfold_list %}
+
+{% if pagination_required %}
+    {% for i in page_range %}
+        <div class="{% if forloop.last %}pr-2{% else %}pr-4{% endif %}">
+            {% paginator_number cl i %}
+        </div>
+    {% endfor %}
+{% endif %}
+
+<div class="py-4">
+    {% if pagination_required %}
+        -
+    {% endif %}
+
+    {{ cl.result_count }}
+
+    {% if cl.result_count == 1 %}
+        {{ cl.opts.verbose_name }}
+    {% else %}
+        {{ cl.opts.verbose_name_plural }}
+    {% endif %}
+</div>

src/unfold/templates/unfold/helpers/pagination_infinite.html

@@ -0,0 +1,11 @@
+{% load unfold_list i18n %}
+
+<div class="flex flex-row gap-4">
+    <a {% if cl.page_num != 1 %}href="?p={{ cl.page_num|add:-1 }}"{% endif %} class="{% if cl.page_num != 1 %}hover:text-primary-600 dark:hover:text-primary-500{% endif %}">
+        {% trans "Previous" %}
+    </a>
+
+    <a href="?p={{ cl.page_num|add:1 }}" class="hover:text-primary-600 dark:hover:text-primary-500">
+        {% trans "Next" %}
+    </a>
+</div>

src/unfold/templates/unfold/helpers/welcomemsg.html

@@ -1,4 +1,4 @@
-{% load i18n %}
+{% load unfold i18n %}
 
 <div class="flex flex-row flex-grow font-semibold items-center min-w-0 mr-3">
     <span class="cursor-pointer flex flex-row items-center">
@@ -23,7 +23,7 @@ <h1 class="overflow-hidden text-ellipsis text-sm whitespace-nowrap xl:text-base
                 {{ content_title }}
             </span>
 
-            {% if cl and cl.full_result_count != cl.result_count %}
+            {% if cl and cl.full_result_count != cl.result_count and cl.paginator|class_name != "InfinitePaginator" %}
                 <span class="font-medium ml-2 text-font-subtle-light text-sm dark:text-font-subtle-dark">
                     {% blocktranslate count counter=cl.result_count %}{{ counter }} result{% plural %}{{ counter }} results{% endblocktranslate %} (<a href="?{% if cl.is_popup %}_popup=1{% endif %}">{% if cl.show_full_result_count %}{% blocktranslate with full_result_count=cl.full_result_count %}{{ full_result_count }} total{% endblocktranslate %}{% else %}{% translate "Show all" %}{% endif %}</a>)
                 </span>