An Eloquent model and Query builder with support for MongoDB, using the original Laravel API. *This library extends the original Laravel classes, so it uses exactly the same methods.*
Laravel Eloquent add support for ODM (Object Document Mapper) to Laravel. It's the same as Eloquent ORM, but with Documents, since MongoDB is a NoSQL database.
Table of contents
-----------------
...
...
@@ -11,25 +11,12 @@ Table of contents
*[Upgrading](#upgrading)
*[Configuration](#configuration)
*[Eloquent](#eloquent)
*[Optional: Alias](#optional-alias)
*[Query Builder](#query-builder)
*[Schema](#schema)
*[Extensions](#extensions)
*[Examples](#examples)
Installation
Laravel Installation
------------
Make sure you have the MongoDB PHP driver installed. You can find installation instructions at http://php.net/manual/en/mongodb.installation.php
**WARNING**: The old mongo PHP driver is not supported anymore in versions >= 3.0.
In case your Laravel version does NOT autoload the packages, add the service provider to `config/app.php`:
```php
Jenssegers\Mongodb\MongodbServiceProvider::class,
```
### Lumen
For usage with [Lumen](http://lumen.laravel.com), 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.
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.
### Non-Laravel projects
For usage outside Laravel, check out the [Capsule manager](https://github.com/illuminate/database/blob/master/README.md) and add:
In this new major release which supports the new mongodb PHP extension, we also moved the location of the Model class and replaced the MySQL model class with a trait.
In this new major release which supports the new MongoDB PHP extension, we also moved the location of the Model class and replaced the MySQL model class with a trait.
Please change all `Jenssegers\Mongodb\Model` references to `Jenssegers\Mongodb\Eloquent\Model` either at the top of your model files, or your registered alias.
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classUserextendsEloquent{}
classUserextendsEloquent
{
//
}
```
If you are using hybrid relations, your MySQL classes should now extend the original Eloquent model class `Illuminate\Database\Eloquent\Model` instead of the removed `Jenssegers\Eloquent\Model`. Instead use the new `Jenssegers\Mongodb\Eloquent\HybridRelations` trait. This should make things more clear as there is only one single model class in this package.
If you are using hybrid relations, your MySQL classes should now extend the original Eloquent model class `Illuminate\Database\Eloquent\Model` instead of the removed `Jenssegers\Eloquent\Model`.
Instead use the new `Jenssegers\Mongodb\Eloquent\HybridRelations` trait. This should make things more clear as there is only one single model class in this package.
```php
useJenssegers\Mongodb\Eloquent\HybridRelations;
classUserextendsEloquent{
classUserextendsEloquent
{
useHybridRelations;
protected$connection='mysql';
}
```
Embedded relations now return an `Illuminate\Database\Eloquent\Collection` rather than a custom Collection class. If you were using one of the special methods that were available, convert them to Collection operations.
```php
$books=$user->books()->sortBy('title');
$books=$user->books()->sortBy('title')->get();
```
Testing
...
...
@@ -119,970 +124,97 @@ docker-compose up
Configuration
-------------
Change your default database connection name in `config/database.php`:
```php
'default'=>env('DB_CONNECTION','mongodb'),
```
And add a new mongodb connection:
You can use MongoDB either as a main database, either as a side database. To do so, add a new `mongodb` connection to `config/database.php`:
```php
'mongodb'=>[
'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'=>[
'database'=>'admin'// sets the authentication database required by mongo 3
]
'host'=>env('DB_HOST','127.0.0.1'),
'port'=>env('DB_PORT',27017),
'database'=>env('DB_DATABASE','homestead'),
'username'=>env('DB_USERNAME','homestead'),
'password'=>env('DB_PASSWORD','secret'),
'options'=>[
'database'=>'admin',// required with Mongo 3+
// here you can pass more settings
// see https://www.php.net/manual/en/mongoclient.construct.php under "Parameters" for a list of complete parameters you can use
],
],
```
You can connect to multiple servers or replica sets with the following configuration:
For multiple servers or replica set configurations, set the host to array and specify each server host:
```php
'mongodb'=>[
'driver'=>'mongodb',
'host'=>['server1','server2'],
'port'=>env('DB_PORT',27017),
'database'=>env('DB_DATABASE'),
'username'=>env('DB_USERNAME'),
'password'=>env('DB_PASSWORD'),
'options'=>[
'replicaSet'=>'replicaSetName'
]
'host'=>['server1','server2',...],
...
'options'=>[
'replicaSet'=>'rs0',
],
],
```
Alternatively, you can use MongoDB connection string:
If you wish to use a connection string instead of a full key-value params, you can set it so. Check the documentation on MongoDB's URI format: https://docs.mongodb.com/manual/reference/connection-string/
```php
'mongodb'=>[
'driver'=>'mongodb',
'dsn'=>env('DB_DSN'),
'database'=>env('DB_DATABASE'),
'database'=>env('DB_DATABASE','homestead'),
],
```
Please refer to MongoDB official docs for its URI format: https://docs.mongodb.com/manual/reference/connection-string/
Eloquent
--------
### Basic Usage
This package includes a MongoDB enabled Eloquent class that you can use to define models for corresponding collections.
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classUserextendsEloquent{}
```
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 collection name unless another name is explicitly specified. You may specify a custom collection (alias for table) by defining a `collection` property on your model:
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classUserextendsEloquent{
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.
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classMyModelextendsEloquent{
protected$connection='mongodb';
useJenssegers\Mongodb\Eloquent\Model;
classBookextendsModel
{
//
}
```
Everything else (should) work just like the original Eloquent model. Read more about the Eloquent on http://laravel.com/docs/eloquent
### Optional: Alias
You may also register an alias for the MongoDB model by adding the following to the alias array in `config/app.php`:
This will allow you to use the registered alias like:
```php
classMyModelextendsMoloquent{}
```
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.
Read more about the query builder on http://laravel.com/docs/queries
Schema
------
Just like a normal model, the MongoDB model class will know which collection to use based on the model name. For `Book`, the collection `books` will be used.
The database driver also has (limited) schema builder support. You can easily manipulate collections and set indexes:
To change the collection, pass the `$collection` property:
```php
Schema::create('users',function($collection)
{
$collection->index('name');
$collection->unique('email');
});
```
You can also pass all the parameters specified in the MongoDB docs [here](https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/#options-for-all-index-types) in the `$options` parameter. For example:
useJenssegers\Mongodb\Eloquent\Model;
```
Schema::create('users', function($collection)
classBookextendsModel
{
$collection->index('username',null,null,[
'sparse' => true,
'unique' => true,
'background' => true
]);
});
protected$collection='my_books_collection';
}
```
Supported operations are:
- create and drop
- collection
- hasCollection
- index and dropIndex (compound indexes supported as well)
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 https://laravel.com/docs/6.0/migrations#tables
### Geospatial indexes
Geospatial indexes are handy for querying location-based documents. They come in two forms: `2d` and `2dsphere`. Use the schema builder to add these to a collection.
To add a `2d` index:
**NOTE:** MongoDb documents are automatically stored with an unique ID that is stored in the `_id` property. If you wish to use your own ID, substitude the `$primaryKey` property and set it to your own primary key attribute name.
```php
Schema::create('users',function($collection)
{
$collection->geospatial('name','2d');
});
```
useJenssegers\Mongodb\Eloquent\Model;
To add a `2dsphere` index:
```php
Schema::create('users',function($collection)
classBookextendsModel
{
$collection->geospatial('name','2dsphere');
});
```
Extensions
----------
### Auth
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.
### Queues
If you want to use MongoDB as your database backend, change the driver in `config/queue.php`:
```php
'connections'=>[
'database'=>[
'driver'=>'mongodb',
'table'=>'jobs',
'queue'=>'default',
'expire'=>60,
],
]
```
If you want to use MongoDB to handle failed jobs, change the database in `config/queue.php`:
If you want to use this library with [Sentry](https://cartalyst.com/manual/sentry), then check out https://github.com/jenssegers/Laravel-MongoDB-Sentry
### Sessions
The MongoDB session driver is available in a separate package, check out https://github.com/jenssegers/Laravel-MongoDB-Session
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:
```php
useJenssegers\Mongodb\Eloquent\SoftDeletes;
classUserextendsEloquent{
useSoftDeletes;
protected$dates=['deleted_at'];
protected$primaryKey='id';
}
```
For more information check http://laravel.com/docs/eloquent#soft-deleting
### MongoDB specific operators
**Exists**
Matches documents that have the specified field.
```php
User::where('age','exists',true)->get();
```
**All**
Matches arrays that contain all elements specified in the query.
**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 MongoDB\BSON\Regex object.
// Mongo will also createa _id, but the 'id' property will be used for primary key actions like find().
Book::create(['id'=>1,'title'=>'The Fault in Our Stars']);
```
**Type**
Selects documents if a field is of the specified type. For more information check: http://docs.mongodb.org/manual/reference/operator/query/type/#op._S_type
Likewise, you may define a `connection` property to override the name of the database connection that should be used when utilizing the model.
```php
User::where('age','type',2)->get();
```
**Mod**
useJenssegers\Mongodb\Eloquent\Model;
Performs a modulo operation on the value of a field and selects documents with a specified result.
```php
User::where('age','mod',[10,0])->get();
classBookextendsModel
{
protected$connection='mongodb';
}
```
**Near**
**NOTE:** Specify coordinates in this order: `longitude, latitude`.
Matches documents that satisfy a JavaScript expression. For more information check http://docs.mongodb.org/manual/reference/operator/query/where/#op._S_where
### Inserts, updates and deletes
Inserting, updating and deleting records works just like the original Eloquent.
**Saving a new model**
```php
$user=newUser;
$user->name='John';
$user->save();
```
You may also use the create method to save a new model in a single line:
```php
User::create(['name'=>'John']);
```
**Updating a model**
To update a model, you may retrieve it, change an attribute, and use the save method.
```php
$user=User::first();
$user->email='john@foo.com';
$user->save();
```
*There is also support for upsert operations, check https://github.com/jenssegers/laravel-mongodb#mongodb-specific-operations*
**Deleting a model**
To delete a model, simply call the delete method on the instance:
```php
$user=User::first();
$user->delete();
```
Or deleting a model by its key:
```php
User::destroy('517c43667db388101e00000f');
```
For more information about model manipulation, check http://laravel.com/docs/eloquent#insert-update-delete
### Dates
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: https://laravel.com/docs/5.0/eloquent#date-mutators
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`:
Other relations are not yet supported, but may be added in the future. Read more about these relations on https://laravel.com/docs/master/eloquent-relationships
### 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.
**REMEMBER**: these relations return Eloquent collections, they don't return query builder objects!
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classUserextendsEloquent{
publicfunctionbooks()
{
return$this->embedsMany('Book');
}
}
```
You can access the embedded models through the dynamic property:
```php
$books=User::first()->books;
```
The inverse relation is auto*magically* available, you don't need to define this reverse relation.
```php
$user=$book->user;
```
Inserting and updating embedded models works similar to the `hasMany` relation:
```php
$book=newBook(['title'=>'A Game of Thrones']);
$user=User::first();
$book=$user->books()->save($book);
// or
$book=$user->books()->create(['title'=>'A Game of Thrones'])
```
You can update embedded models using their `save` method (available since release 2.0.0):
```php
$book=$user->books()->first();
$book->title='A Game of Thrones';
$book->save();
```
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):
```php
$book=$user->books()->first();
$book->delete();
// or
$user->books()->destroy($book);
```
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:
```php
$user->books()->associate($book);
$user->save();
```
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:
```php
return$this->embedsMany('Book','local_key');
```
Embedded relations will return a Collection of embedded items instead of a query builder. Check out the available operations here: https://laravel.com/docs/master/collections
### EmbedsOne Relations
The embedsOne relation is similar to the embedsMany relation, but only embeds a single model.
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classBookextendsEloquent{
publicfunctionauthor()
{
return$this->embedsOne('Author');
}
}
```
You can access the embedded models through the dynamic property:
```php
$author=Book::first()->author;
```
Inserting and updating embedded models works similar to the `hasOne` relation:
You can update the embedded model using the `save` method (available since release 2.0.0):
```php
$author=$book->author;
$author->name='Jane Doe';
$author->save();
```
You can replace the embedded model with a new model like this:
```php
$newAuthor=newAuthor(['name'=>'Jane Doe']);
$book->author()->save($newAuthor);
```
### 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 use the `Jenssegers\Mongodb\Eloquent\HybridRelations` trait. Note that this functionality only works for hasOne, hasMany and belongsTo relations.
Example SQL-based User model:
```php
useJenssegers\Mongodb\Eloquent\HybridRelations;
classUserextendsEloquent{
useHybridRelations;
protected$connection='mysql';
publicfunctionmessages()
{
return$this->hasMany('Message');
}
}
```
And the Mongodb-based Message model:
```php
useJenssegers\Mongodb\Eloquent\ModelasEloquent;
classMessageextendsEloquent{
protected$connection='mongodb';
publicfunctionuser()
{
return$this->belongsTo('User');
}
}
```
### Raw Expressions
These expressions will be injected directly into the query.
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.
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:
