This Laravel Eloquent extension allows limiting the number of eager loading results per parent using window functions.
Supports Laravel 5.5.29+.
- MySQL 5.7+
- MySQL 5.5~5.6: Due to a bug in MySQL, the package only works with strict mode disabled.
In yourconfig/database.php
file, set'strict' => false,
for the MySQL connection. - MariaDB 10.2+: Due to a bug in MariaDB, the package only works with strict mode disabled.
In yourconfig/database.php
file, set'strict' => false,
for the MariaDB connection. - PostgreSQL 9.3+
- SQLite 3.25+: The limit is ignored on older versions of SQLite. This way, your application tests still work.
- SQL Server 2008+
composer require staudenmeir/eloquent-eager-limit:"^1.0"
Use this command if you are in PowerShell on Windows (e.g. in VS Code):
composer require staudenmeir/eloquent-eager-limit:"^^^^1.0"
Use the HasEagerLimit
trait in both the parent and the related model and apply limit()/take()
to your relationship:
class User extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
public function posts()
{
return $this->hasMany('App\Post');
}
}
class Post extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
}
$users = User::with(['posts' => function ($query) {
$query->latest()->limit(10);
}])->get();
Improve the performance of HasOne
/HasOneThrough
/MorphOne
relationships by applying limit(1)
:
class User extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
public function latestPost()
{
return $this->hasOne('App\Post')->latest()->limit(1);
}
}
class Post extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
}
$users = User::with('latestPost')->get();
You can also apply offset()/skip()
to your relationship:
class User extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
public function posts()
{
return $this->hasMany('App\Post');
}
}
class Post extends Model
{
use \Staudenmeir\EloquentEagerLimit\HasEagerLimit;
}
$users = User::with(['posts' => function ($query) {
$query->latest()->offset(5)->limit(10);
}])->get();
Please see CONTRIBUTING and CODE OF CONDUCT for details.