Django pagination uses the LIMIT/OFFSET method. This is fine for smaller offsets, but once you start getting beyond a few pages, it can perform really badly. This is because the database needs to fetch all of the previous rows, even though it discards them.
Using Keyset Pagination allows for better performing "next page" fetches, at the cost of not being able to randomly fetch a page. That is, if you know the last element from page N-1, then you may fetch page N, but otherwise you really can't.
Keyset Pagination, sometimes called the Seek Method, has been documented by [Markus Winand](https://use-the-index-luke.com/sql/partial-results/fetch-next-page) and [Joe Nelson](https://www.citusdata.com/blog/2016/03/30/five-ways-to-paginate/). If you are not familiar with the concept, I strongly suggest you read the articles above.
In order to use the paginator within this package, you will probably also need to use the provided View mixin: this changes the way a queryset is paginated to enable non-integer "page numbers".
class List(PaginationMixin, ListView):
paginator_class = KeysetPaginator
paginate_by = 10
queryset = MyModel.objects.order_by('-timestamp', 'group')
You won't be able to iterate through page numbers in a template in the same way: you are limited to next and previous pages. Otherwise, you construct them in largely the same way:
<a href="{% url 'mymodel:list' %}?page={{ page_obj.previous_page_number }}">
Prev Page
</a>
<a href="{% url 'mymodel:list' %}?page={{ page_obj.next_page_number }}">
Next Page
</a>
Note that you do not get access to the length of the queryset, nor the number of pages, because these could be expensive queries. You really don't need to know that ;)
However, I like to use GET forms to [enable pagination of filtered results](https://schinckel.net/2014/08/17/leveraging-html-and-django-forms%3A-pagination-of-filtered-results/):
<button form="target-form"
name="page"
value="{{ page_obj.previous_page_number }}"
type="submit">
← Prev Page
</button>
<button form="target-form"
name="page"
value="{{ page_obj.next_page_number }}"
type="submit">
Next Page →
<button>
See https://schinckel.net/2018/11/23/keyset-pagination-in-django/ for more details about how this package works.
Metadata
Release files for django-keyset-pagination-plus 0.9.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| django-keyset-pagination-plus-0.9.2.tar.gz | 6.9 kB | Without provenance | Details for django-keyset-pagination-plus-0.9.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| django_keyset_pagination_plus-0.9.2-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for django_keyset_pagination_plus-0.9.2-py2.py3-none-any.whl |
Total release size: 14.4 kB
Release files / django-keyset-pagination-plus-0.9.2.tar.gz
| Download URL | django-keyset-pagination-plus-0.9.2.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
624d29b1b03988bc47a64a9b6d94878ecd7b3a37491db8541864ecf7dbfa056e
|
|
BLAKE2b-256 checksum How to use checksums |
700ef6e81218466b172900b05b8ed8c8edcd53011ec0c8a7800a158b8470ed41
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Python-urllib/3.7
|
Release files / django_keyset_pagination_plus-0.9.2-py2.py3-none-any.whl
| Download URL | django_keyset_pagination_plus-0.9.2-py2.py3-none-any.whl |
|---|---|
| Size | 7.6 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
74d7793a45c2feebd7bddb0dee9fb0f62286e1b60850aa06cd73a4c1a7687094
|
|
BLAKE2b-256 checksum How to use checksums |
086c4a7153f637ab95141e378cdb19edefdfda89e86dbb76ab7afdff4b4e6073
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.1
|
Security for django-keyset-pagination-plus 0.9.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.