A MongoDB based Eloquent model and Query builder for Laravel 5

1.0 2016-01-07 18:06 UTC

This package is not auto-updated.

Last update: 2022-01-12 05:15:44 UTC


Build Status Packagist Packagist Packagist Packagist

Installation via Composer

composer require symfomany/laravel-mongo

MongoDB PHP Project

Adaptation of Mongo/laravel-mongodb for PHP7 and MongoDB Driver support


  • Bridge for Eloquant ORM & Query Builder to Laravel 5


  • Illuminate Query Builder on Laravel 5
  • Eloquent ORM
  • mongodb/mongodb

Goals & Evolution

Explore API MongoDB to extends native features:

  • Database info
  • Bulk
  • DeleteMany
  • Delete
  • FindAndModify
  • FindAndDelete
  • InsertMany
  • Agregate: create command & execute
  • DeleteResult / InsertManyResult /InsertOneResult / UpdateResult


First Part: MongoDB

Connection (options)

  • collection() table()
  • getCollection()
  • getSchemaBuilder()
  • getMongoClient() => Cient
  • getMongoDB() => db
  • createConnection() / getDriverName()
  • getDsn()
  • disconnect()

Collection ( Connection/ Collection Mongo DRiver

  • __call() => faire appel au methode natives du Driver + Gestion des logs

Builder (connection + Processor of query)

  • operators => available clause operators

  • conversion => Operator conversion. = > < !=

  • project() => projections

  • timeout() => delai max

  • hint() => index special ds la requete

  • find($id, $columns) => id avec les colonnes de sorties

  • get($columns) => retourne tous sauf columns de conditions

  • getFresh() alias de get() => colonnes de sorties

  • generateCacheKey()

  • aggregate()

  • exists() => si n'mport quelle resulat existe ds la requete

  • distinct() => Force the query to only return distinct results.

  • orderBy() => ajoute un tri ds la requete avec directon

  • whereBetween() => un where vec Between ...AND..

  • forPage($page) => limit et offset pour une page avec skip et take

  • insert(array) => insert + batch insert

  • insertGetId() => insert et retour l'id insérer

  • update($values) => modifie

  • increment($column) => incrémente une colonne

  • decrement($column) => décréùente une colonne

  • delete($id)

  • from()

  • truncate()

  • lists() => Get an array with the values of a given column.

  • raw() => evaluate an expression

  • push() => Append one or more values to an array

  • pull() => Remove one or more values from an array

  • drop() => Remove one or more fields.

  • newQuery() => new instance of the query builder.(subquery)

  • convertKey() => ???

  • where()

  • compileWheres() => convertis les mots clefs + id +AND|OR + Recursisve where

  • compileWhereBasic() => Like +Regexp +not +

  • compileWhereNested() + compileWhereIn() + compileWhereNotIn()() + compileWhereNull() + compileWhereNotNull() + compileWhereBetween() + compileWhereRaw()

  • NB: Collection must have Collection Eloquant method or BaseCollection (abstract)

Second Part: Eloquant ORM



SchemaBuilder (with connection)

  • hasTable() / hasCollection() / hasColumns()
  • create() / drop()

Table of contents


Make sure you have the MongoDB PHP driver installed. You can find installation instructions at

For Laravel 5, install the latest stable version using composer:

composer require symfomany/laravel-mongo

Version Compatibility

Laravel Package
4.2.x 2.0.x
5.0.x 2.1.x
5.1.x 2.2.x

And add the service provider in config/app.php:


For usage with Lumen, add the service provider in bootstrap/app.php. In this file, you will also need to enable Eloquent. You must however ensure that your call to $app->withEloquent(); is below where you have registered the MongodbServiceProvider:



The service provider will register a mongodb database extension with the original database manager. There is no need to register additional facades or objects. When using mongodb connections, Laravel will automatically provide you with the corresponding mongodb objects.

For usage outside Laravel, check out the Capsule manager and add:

$capsule->getDatabaseManager()->extend('mongodb', function($config)
    return new Mongo\Mongodb\Connection($config);


Change your default database connection name in app/config/database.php:

'default' => env('DB_CONNECTION', 'mongodb'),

And add a new mongodb connection:

'mongodb' => array(
    'driver'   => 'mongodb',
    'host'     => env('DB_HOST', 'localhost'),
    'port'     => env('DB_PORT', 27017),
    'database' => env('DB_DATABASE', ''),
    'username' => env('DB_USERNAME', ''),
    'password' => env('DB_PASSWORD', ''),
    'options' => array(
        'db' => 'admin' // sets the authentication database required by mongo 3

You can connect to multiple servers or replica sets with the following configuration:

'mongodb' => array(
    'driver'   => 'mongodb',
    'host'     => array('server1', 'server2'),
    'port'     => env('DB_PORT', 27017),
    'database' => env('DB_DATABASE', ''),
    'username' => env('DB_USERNAME', ''),
    'password' => env('DB_PASSWORD', ''),
    'options'  => array('replicaSet' => 'replicaSetName')


This package includes a MongoDB enabled Eloquent class that you can use to define models for corresponding collections.

use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {}

Note that we did not tell Eloquent which collection to use for the User model. Just like the original Eloquent, the lower-case, plural name of the class will be used as the table name unless another name is explicitly specified. You may specify a custom collection (alias for table) by defining a collection property on your model:

use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    protected $collection = 'users_collection';


NOTE: Eloquent will also assume that each collection has a primary key column named id. You may define a primaryKey property to override this convention. Likewise, you may define a connection property to override the name of the database connection that should be used when utilizing the model.

use Mongo\Mongodb\Model as Eloquent;

class MyModel extends Eloquent {

    protected $connection = 'mongodb';


Everything else works just like the original Eloquent model. Read more about the Eloquent on

Optional: Alias

You may also register an alias for the MongoDB model by adding the following to the alias array in app/config/app.php:

'Moloquent'       => 'Mongo\Mongodb\Model',

This will allow you to use the registered alias like:

class MyModel extends Moloquent {}

Query Builder

The database driver plugs right into the original query builder. When using mongodb connections, you will be able to build fluent queries to perform database operations. For your convenience, there is a collection alias for table as well as some additional mongodb specific operators/operations.

$users = DB::collection('users')->get();

$user = DB::collection('users')->where('name', 'John')->first();

If you did not change your default database connection, you will need to specify it when querying.

$user = DB::connection('mongodb')->collection('users')->get();

Read more about the query builder on


The database driver also has (limited) schema builder support. You can easily manipulate collections and set indexes:

Schema::create('users', function($collection)


Supported operations are:

  • create and drop
  • collection
  • hasCollection
  • index and dropIndex (compound indexes supported as well)
  • unique
  • background, sparse, expire (MongoDB specific)

All other (unsupported) operations are implemented as dummy pass-through methods, because MongoDB does not use a predefined schema. Read more about the schema builder on



If you want to use Laravel's native Auth functionality, register this included service provider:


This service provider will slightly modify the internal DatabaseReminderRepository to add support for MongoDB based password reminders. If you don't use password reminders, you don't have to register this service provider and everything else should work just fine.


If you want to use this library with Sentry, then check out


The MongoDB session driver is available in a separate package, check out


Class 'MongoClient' not found in ...

The MongoClient class is part of the MongoDB PHP driver. Usually, this error means that you forgot to install, or did not install this driver correctly. You can find installation instructions for this driver at

To check if you have installed the driver correctly, run the following command:

$ php -i | grep 'Mongo'
MongoDB Support => enabled

Argument 2 passed to Illuminate\Database\Query\Builder::__construct() must be an instance of Illuminate\Database\Query\Grammars\Grammar, null given

To solve this, you will need to check two things. First check if your model is extending the correct class; this class should be Mongo\Mongodb\Model. Secondly, check if your model is using a MongoDB connection. If you did not change the default database connection in your database configuration file, you need to specify the MongoDB enabled connection. This is what your class should look like if you did not set up an alias and change the default database connection:

use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    protected $connection = 'mongodb';



Basic Usage

Retrieving All Models

$users = User::all();

Retrieving A Record By Primary Key

$user = User::find('517c43667db388101e00000f');


$users = User::where('votes', '>', 100)->take(10)->get();

Or Statements

$users = User::where('votes', '>', 100)->orWhere('name', 'John')->get();

And Statements

$users = User::where('votes', '>', 100)->where('name', '=', 'John')->get();

Using Where In With An Array

$users = User::whereIn('age', array(16, 18, 20))->get();

When using whereNotIn objects will be returned if the field is non existent. Combine with whereNotNull('age') to leave out those documents.

Using Where Between

$users = User::whereBetween('votes', array(1, 100))->get();

Where null

$users = User::whereNull('updated_at')->get();

Order By

$users = User::orderBy('name', 'desc')->get();

Offset & Limit

$users = User::skip(10)->take(5)->get();


Distinct requires a field for which to return the distinct values.

$users = User::distinct()->get(array('name'));
// or
$users = User::distinct('name')->get();

Distinct can be combined with where:

$users = User::where('active', true)->distinct('name')->get();

Advanced Wheres

$users = User::where('name', '=', 'John')->orWhere(function($query)
        $query->where('votes', '>', 100)
              ->where('title', '<>', 'Admin');

Group By

Selected columns that are not grouped will be aggregated with the $last function.

$users = Users::groupBy('title')->get(array('title', 'name'));


Aggregations are only available for MongoDB versions greater than 2.2.

$total = Order::count();
$price = Order::max('price');
$price = Order::min('price');
$price = Order::avg('price');
$total = Order::sum('price');

Aggregations can be combined with where:

$sold = Orders::where('sold', true)->sum('price');


$user = Comment::where('body', 'like', '%spam%')->get();

Incrementing or decrementing a value of a column

Perform increments or decrements (default 1) on specified attributes:

User::where('name', 'John Doe')->increment('age');
User::where('name', 'Jaques')->decrement('weight', 50);

The number of updated objects is returned:

$count = User->increment('age');

You may also specify additional columns to update:

User::where('age', '29')->increment('age', 1, array('group' => 'thirty something'));
User::where('bmi', 30)->decrement('bmi', 1, array('category' => 'overweight'));

Soft deleting

When soft deleting a model, it is not actually removed from your database. Instead, a deleted_at timestamp is set on the record. To enable soft deletes for a model, apply the SoftDeletingTrait to the model:

use Mongo\Mongodb\Eloquent\SoftDeletes;

class User extends Eloquent {

    use SoftDeletes;

    protected $dates = ['deleted_at'];


For more information check

MongoDB specific operators


Matches documents that have the specified field.

User::where('age', 'exists', true)->get();


Matches arrays that contain all elements specified in the query.

User::where('roles', 'all', array('moderator', 'author'))->get();


Selects documents if the array field is a specified size.

User::where('tags', 'size', 3)->get();


Selects documents where values match a specified regular expression.

User::where('name', 'regex', new MongoRegex("/.*doe/i"))->get();

NOTE: you can also use the Laravel regexp operations. These are a bit more flexible and will automatically convert your regular expression string to a MongoRegex object.

User::where('name', 'regexp', '/.*doe/i'))->get();

And the inverse:

User::where('name', 'not regexp', '/.*doe/i'))->get();


Selects documents if a field is of the specified type. For more information check:

User::where('age', 'type', 2)->get();


Performs a modulo operation on the value of a field and selects documents with a specified result.

User::where('age', 'mod', array(10, 0))->get();


Matches documents that satisfy a JavaScript expression. For more information check

Inserts, updates and deletes

Inserting, updating and deleting records works just like the original Eloquent.

Saving a new model

$user = new User;
$user->name = 'John';

You may also use the create method to save a new model in a single line:

User::create(array('name' => 'John'));

Updating a model

To update a model, you may retrieve it, change an attribute, and use the save method.

$user = User::first();
$user->email = '';

There is also support for upsert operations, check

Deleting a model

To delete a model, simply call the delete method on the instance:

$user = User::first();

Or deleting a model by its key:


For more information about model manipulation, check


Eloquent allows you to work with Carbon/DateTime objects instead of MongoDate objects. Internally, these dates will be converted to MongoDate objects when saved to the database. If you wish to use this functionality on non-default date fields you will need to manually specify them as described here:


use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    protected $dates = array('birthday');


Which allows you to execute queries like:

$users = User::where('birthday', '>', new DateTime('-18 years'))->get();


Supported relations are:

  • hasOne
  • hasMany
  • belongsTo
  • belongsToMany


use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    public function items()
        return $this->hasMany('Item');


And the inverse relation:

use Mongo\Mongodb\Model as Eloquent;

class Item extends Eloquent {

    public function user()
        return $this->belongsTo('User');


The belongsToMany relation will not use a pivot "table", but will push id's to a related_ids attribute instead. This makes the second parameter for the belongsToMany method useless. If you want to define custom keys for your relation, set it to null:

use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    public function groups()
        return $this->belongsToMany('Group', null, 'users', 'groups');


Other relations are not yet supported, but may be added in the future. Read more about these relations on

EmbedsMany Relations

If you want to embed models, rather than referencing them, you can use the embedsMany relation. This relation is similar to the hasMany relation, but embeds the models inside the parent object.

use Mongo\Mongodb\Model as Eloquent;

class User extends Eloquent {

    public function books()
        return $this->embedsMany('Book');


You access the embedded models through the dynamic property:

$books = User::first()->books;

The inverse relation is automagically available, you don't need to define this reverse relation.

$user = $book->user;

Inserting and updating embedded models works similar to the hasMany relation:

$book = new Book(array('title' => 'A Game of Thrones'));

$user = User::first();

$book = $user->books()->save($book);
// or
$book = $user->books()->create(array('title' => 'A Game of Thrones'))

You can update embedded models using their save method (available since release 2.0.0):

$book = $user->books()->first();

$book->title = 'A Game of Thrones';


You can remove an embedded model by using the destroy method on the relation, or the delete method on the model (available since release 2.0.0):

$book = $user->books()->first();

// or

If you want to add or remove an embedded model, without touching the database, you can use the associate and dissociate methods. To eventually write the changes to the database, save the parent object:



Like other relations, embedsMany assumes the local key of the relationship based on the model name. You can override the default local key by passing a second argument to the embedsMany method:

return $this->embedsMany('Book', 'local_key');

Embedded relations will return a Collection of embedded items instead of a query builder. To allow a more query-like behavior, a modified version of the Collection class is used, with support for the following additional operations:

  • where($key, $operator, $value)
  • whereIn($key, $values) and whereNotIn($key, $values)
  • whereBetween($key, $values) and whereNotBetween($key, $values)
  • whereNull($key) and whereNotNull($key)
  • orderBy($key, $direction)
  • oldest() and latest()
  • limit($value)
  • offset($value)
  • skip($value)

This allows you to execute simple queries on the collection results:

$books = $user->books()->where('rating', '>', 5)->orderBy('title')->get();

Note: Because embedded models are not stored in a separate collection, you can not query all of embedded models. You will always have to access them through the parent model.

EmbedsOne Relations

The embedsOne relation is similar to the EmbedsMany relation, but only embeds a single model.

use Mongo\Mongodb\Model as Eloquent;

class Book extends Eloquent {

    public function author()
        return $this->embedsOne('Author');


You access the embedded models through the dynamic property:

$author = Book::first()->author;

Inserting and updating embedded models works similar to the hasOne relation:

$author = new Author(array('name' => 'John Doe'));

$book = Books::first();

$author = $book->author()->save($author);
// or
$author = $book->author()->create(array('name' => 'John Doe'));

You can update the embedded model using the save method (available since release 2.0.0):

$author = $book->author;

$author->name = 'Jane Doe';

You can replace the embedded model with a new model like this:

$newAuthor = new Author(array('name' => 'Jane Doe'));

MySQL Relations

If you're using a hybrid MongoDB and SQL setup, you're in luck! The model will automatically return a MongoDB- or SQL-relation based on the type of the related model. Of course, if you want this functionality to work both ways, your SQL-models will need to extend Mongo\Eloquent\Model. Note that this functionality only works for hasOne, hasMany and belongsTo relations.

Example SQL-based User model:

use Mongo\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $connection = 'mysql';

    public function messages()
        return $this->hasMany('Message');


And the Mongodb-based Message model:

use Mongo\Mongodb\Model as Eloquent;

class Message extends Eloquent {

    protected $connection = 'mongodb';

    public function user()
        return $this->belongsTo('User');


Raw Expressions

These expressions will be injected directly into the query.

User::whereRaw(array('age' => array('$gt' => 30, '$lt' => 40)))->get();

You can also perform raw expressions on the internal MongoCollection object. If this is executed on the model class, it will return a collection of models. If this is executed on the query builder, it will return the original response.

// Returns a collection of User models.
$models = User::raw(function($collection)
    return $collection->find();

// Returns the original MongoCursor.
$cursor = DB::collection('users')->raw(function($collection)
    return $collection->find();

Optional: if you don't pass a closure to the raw method, the internal MongoCollection object will be accessible:

$model = User::raw()->findOne(array('age' => array('$lt' => 18)));

The internal MongoClient and MongoDB objects can be accessed like this:

$client = DB::getMongoClient();
$db = DB::getMongoDB();

MongoDB specific operations

Cursor timeout

To prevent MongoCursorTimeout exceptions, you can manually set a timeout value that will be applied to the cursor:



Update or insert a document. Additional options for the update method are passed directly to the native update method.

DB::collection('users')->where('name', 'John')
                       ->update($data, array('upsert' => true));


You can apply projections to your queries using the project method.

DB::collection('items')->project(array('tags' => array('$slice' => 1)))->get();

Projections with Pagination

$limit = 25;
$projections = array('id', 'name');
DB::collection('items')->paginate($limit, $projections);


Add an items to an array.

DB::collection('users')->where('name', 'John')->push('items', 'boots');
DB::collection('users')->where('name', 'John')->push('messages', array('from' => 'Jane Doe', 'message' => 'Hi John'));

If you don't want duplicate items, set the third parameter to true:

DB::collection('users')->where('name', 'John')->push('items', 'boots', true);


Remove an item from an array.

DB::collection('users')->where('name', 'John')->pull('items', 'boots');
DB::collection('users')->where('name', 'John')->pull('messages', array('from' => 'Jane Doe', 'message' => 'Hi John'));


Remove one or more fields from a document.

DB::collection('users')->where('name', 'John')->unset('note');

You can also perform an unset on a model.

$user = User::where('name', 'John')->first();

Query Caching

You may easily cache the results of a query using the remember method:

$users = User::remember(10)->get();


Query Logging

By default, Laravel keeps a log in memory of all queries that have been run for the current request. However, in some cases, such as when inserting a large number of rows, this can cause the application to use excess memory. To disable the log, you may use the disableQueryLog method: