Skip to content
Laravel Eloquent eager loading with limit
Branch: master
Clone or download
Latest commit c502c0d May 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src Update style Apr 25, 2019
tests Support Laravel 5.8 Feb 26, 2019
.gitattributes Various improvements Feb 25, 2019
.gitignore Various improvements Feb 25, 2019
.scrutinizer.yml Update code coverage testing Dec 18, 2018
.travis.yml Support Laravel 5.8 Feb 26, 2019
LICENSE Initial commit Oct 23, 2018
README.md Update README May 19, 2019
composer.json Support Laravel 5.8 Feb 26, 2019
phpunit.xml.dist Test code coverage Dec 17, 2018

README.md

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Total Downloads License

Introduction

This Laravel Eloquent extension allows limiting the number of eager loading results per parent using window functions.

Supports Laravel 5.5.29+.

Compatibility

  • MySQL 5.5+
  • MariaDB 10.2+: Due to a bug in MariaDB, the package only works with strict mode disabled.
    In your config/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+

Installation

composer require staudenmeir/eloquent-eager-limit:"^1.0"

Usage

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();
You can’t perform that action at this time.