helixdigital-io / fast-paginate
[UNOFFICIAL] Fast paginate for Laravel
Requires
- php: ^7.4|^8.0
- illuminate/database: ^8.37|^9.0|^10.0|^11.0
Requires (Dev)
- laravel/scout: ^9.4
- mockery/mockery: ^1.3.3
- orchestra/testbench: ^6|^7|^8.0
- phpunit/phpunit: >=8.5.23|^9
README
About
This is a fast limit/offset pagination macro for Laravel. It can be used in place of the standard paginate methods.
This package uses a SQL method similar to a "deferred join" to achieve this speedup. A deferred join is a technique that defers access to requested columns until after the offset and limit have been applied.
In our case we don't actually do a join, but rather a where in with a subquery. Using this technique we create a subquery that can be optimized with specific indexes for maximum speed and then use those results to fetch the full rows.
The SQL looks something like this:
select * from contacts -- The full data that you want to show your users. where contacts.id in ( -- The "deferred join" or subquery, in our case. select id from contacts -- The pagination, accessing as little data as possible - ID only. limit 15 offset 150000 )
You might get an error trying to run the query above! Something like
This version of MySQL doesn't yet support 'LIMIT & IN/ALL/ANY/SOME subquery.In this package, we run them as two separate queries to get around that!
The benefits can vary based on your dataset, but this method allows the database to examine as little data as possible to satisfy the user's intent.
It's unlikely that this method will ever perform worse than traditional offset / limit, although it is possible, so be
sure to test on your data!
If you want to read 3,000 words on the theory of this package, you can head over to aaronfrancis.com/2022/efficient-pagination-using-deferred-joins.
Installation
This package supports Laravel 8, 9, and 10. (Laravel 8 must be 8.37 or higher.)
To install, require the package via composer:
composer require hammerstone/fast-paginate
There is nothing further you need to do. The service provider will be loaded automatically by Laravel.
Usage
Anywhere you would use Model::query()->paginate(), you can use Model::query()->fastPaginate()! That's it! The method signature is the same.
Relationships are supported as well:
User::first()->posts()->fastPaginate();
A Favor
If this helps you, please tweet at me with before and after times! I'd love to know :D
Some community results so far: