README

使用原始 Laravel API 支持 MongoDB 的 Eloquent 模型和查询构建器。 此库扩展了原始 Laravel 类，因此使用完全相同的方法。

目录

• 安装
• 升级
• 配置
• Eloquent
• 可选：别名
• 查询构建器
• 模式
• 扩展
• 故障排除
• 示例

安装

请确保您已安装 MongoDB PHP 驱动程序。您可以在 https://php.ac.cn/manual/en/mongodb.installation.php 找到安装说明。

警告：旧版的 mongo PHP 驱动程序不再支持 >= 3.0 版本。

使用 composer 安装

composer require jenssegers/mongodb

Laravel 版本兼容性

并在 config/app.php 中添加服务提供者

Jenssegers\Mongodb\MongodbServiceProvider::class,

对于与 Lumen 的使用，请在 bootstrap/app.php 中添加服务提供者。在此文件中，您还需要启用 Eloquent。但是，您必须确保您的 $app->withEloquent(); 调用 位于 您已注册的 MongodbServiceProvider 下方。

$app->register('Jenssegers\Mongodb\MongodbServiceProvider');

$app->withEloquent();

服务提供者将为原始数据库管理器注册一个 mongodb 数据库扩展。不需要注册额外的外观或对象。当使用 mongodb 连接时，Laravel 将自动为您提供相应的 mongodb 对象。

对于 Laravel 之外的使用，请查看 Capsule 管理器 并添加

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

升级

从版本 2 升级到 3

在这个新的主要版本中，它支持新的 mongodb PHP 扩展，我们还移动了 Model 类的位置，并用特质替换了 MySQL 模型类。

请将所有 Jenssegers\Mongodb\Model 引用更改为 Jenssegers\Mongodb\Eloquent\Model，无论是在模型文件的顶部还是在您的注册别名中。

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {}

如果您使用混合关系，则您的 MySQL 类现在应扩展原始 Eloquent 模型类 Illuminate\Database\Eloquent\Model 而不是已删除的 Jenssegers\Eloquent\Model。相反，请使用新的 Jenssegers\Mongodb\Eloquent\HybridRelations 特质。这应该使事情更加清晰，因为此包中只有一个模型类。

use Jenssegers\Mongodb\Eloquent\HybridRelations;

class User extends Eloquent {

    use HybridRelations;

    protected $connection = 'mysql';

}

嵌入式关系现在返回一个 Illuminate\Database\Eloquent\Collection 而不是自定义 Collection 类。如果您使用了其中一种特殊方法，请将它们转换为 Collection 操作。

$books = $user->books()->sortBy('title');

配置

在 app/config/database.php 中更改默认数据库连接名称

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

并添加一个新的 mongodb 连接

'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
    ]
],

您可以使用以下配置连接到多个服务器或副本集

'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']
],

Eloquent

此包包含一个启用 MongoDB 的 Eloquent 类，您可以使用它来定义对应集合的模型。

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {}

请注意，我们没有告诉 Eloquent 为 User 模型使用哪个集合。与原始 Eloquent 一样，除非显式指定，否则类的下划线，复数名称将用作表名。您可以通过在模型上定义 collection 属性来指定自定义集合（表别名）。

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $collection = 'users_collection';

}

注意： Eloquent 还将假设每个集合都有一个名为 id 的主键列。您可以通过定义 primaryKey 属性来覆盖此约定。同样，您还可以定义 connection 属性来覆盖在利用模型时应使用的数据库连接的名称。

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class MyModel extends Eloquent {

    protected $connection = 'mongodb';

}

其他一切（应该）都像原始 Eloquent 模型一样工作。有关 Eloquent 的更多信息，请参阅 https://laravel.net.cn/docs/eloquent

可选：别名

您还可以通过在 app/config/app.php 中的别名数组中添加以下内容来注册 MongoDB 模型的别名

'Moloquent'       => 'Jenssegers\Mongodb\Eloquent\Model',

这将允许您像以下那样使用已注册的别名

class MyModel extends Moloquent {}

查询构建器

数据库驱动程序直接插入原始查询构建器。当使用 mongodb 连接时，您将能够构建流畅的查询以执行数据库操作。为了方便起见，还有 collection 别名以及一些额外的 mongodb 特定运算符/操作。

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

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

如果您没有更改默认的数据库连接，则查询时需要指定它。

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

有关查询构建器的更多信息，请参阅 https://laravel.net.cn/docs/queries

模式

数据库驱动程序还支持（有限的）模式构建器。您可以轻松地操作集合并设置索引

Schema::create('users', function($collection)
{
    $collection->index('name');

    $collection->unique('email');
});

支持的操作包括

• 创建和删除
• collection
• hasCollection
• index 和 dropIndex（支持复合索引）
• unique
• background，sparse，expire（MongoDB 特定）

所有其他（不支持）的操作都作为虚拟透传方法实现，因为 MongoDB 不使用预定义的模式。有关模式构建器的更多信息，请参阅 https://laravel.net.cn/docs/schema

扩展

身份验证

如果您想使用 Laravel 的原生身份验证功能，请注册此包含的服务提供程序

'Jenssegers\Mongodb\Auth\PasswordResetServiceProvider',

此服务提供程序将略微修改内部 DatabaseReminderRepository，以添加基于 MongoDB 的密码提醒支持。如果您不使用密码提醒，则无需注册此服务提供程序，其他一切应该都能正常工作。

队列

如果您想将 MongoDB 用作数据库后端，请更改 config/queue.php 中的驱动程序

'connections' => [
    'database' => [
        'driver' => 'mongodb',
        'table'  => 'jobs',
        'queue'  => 'default',
        'expire' => 60,
    ],

Sentry

如果您想与 Sentry 一起使用此库，请参阅 https://github.com/jenssegers/Laravel-MongoDB-Sentry

会话

MongoDB 会话驱动程序在单独的包中可用，请参阅 https://github.com/jenssegers/Laravel-MongoDB-Session

示例

基本用法

检索所有模型

$users = User::all();

通过主键检索记录

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

Wheres

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

Or 语句

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

And 语句

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

使用数组中的 Where In

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

当使用 whereNotIn 时，如果字段不存在，将返回对象。结合使用 whereNotNull('age') 以排除这些文档。

使用 Where Between

$users = User::whereBetween('votes', [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

Distinct 需要一个返回唯一值的字段。

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

Distinct 可以与 where 结合使用

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

高级 Wheres

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

Group By

未分组的所选列将使用 $last 函数进行聚合。

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

聚合

聚合仅在 MongoDB 版本大于 2.2 时可用。

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

聚合可以与 where 结合使用

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

Like

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

增加或减少列的值

在指定的属性上执行增加或减少（默认为 1）

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

返回更新对象的数量

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

您还可以指定要更新的额外列

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

软删除

当软删除一个模型时，它实际上不会被从数据库中删除。相反，会在记录上设置一个deleted_at时间戳。为了使模型启用软删除，请将SoftDeletingTrait应用于模型

use Jenssegers\Mongodb\Eloquent\SoftDeletes;

class User extends Eloquent {

    use SoftDeletes;

    protected $dates = ['deleted_at'];

}

有关更多信息，请查看https://laravel.net.cn/docs/eloquent#soft-deleting

MongoDB特定运算符

存在

匹配具有指定字段的文档。

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

所有

匹配包含查询中指定所有元素的数组。

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

大小

如果数组字段是指定的大小，则选择文档。

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

正则表达式

选择与指定正则表达式匹配的值的文档。

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

注意：您还可以使用Laravel正则表达式操作。这些操作更灵活，并且会自动将您的正则表达式字符串转换为MongoRegex对象。

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

和它的逆运算

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

类型

如果字段是指定的类型，则选择文档。有关更多信息，请查看：http://docs.mongodb.org/manual/reference/operator/query/type/#op._S_type

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

模

在字段的值上执行模运算，并选择具有指定结果的文档。

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

where

匹配满足JavaScript表达式的文档。有关更多信息，请查看：http://docs.mongodb.org/manual/reference/operator/query/where/#op._S_where

插入、更新和删除

插入、更新和删除记录的工作方式与原始Eloquent相同。

保存新模型

$user = new User;
$user->name = 'John';
$user->save();

您还可以使用create方法在单行中保存新模型

User::create(['name' => 'John']);

更新模型

要更新模型，您可以检索它，更改属性，然后使用save方法。

$user = User::first();
$user->email = 'john@foo.com';
$user->save();

还支持upsert操作，请查看https://github.com/jenssegers/laravel-mongodb#mongodb-specific-operations

删除模型

要删除模型，只需在实例上调用delete方法

$user = User::first();
$user->delete();

或通过其键删除模型

User::destroy('517c43667db388101e00000f');

有关模型操作的更多信息，请查看https://laravel.net.cn/docs/eloquent#insert-update-delete

日期

Eloquent允许您使用Carbon/DateTime对象而不是MongoDate对象。内部，这些日期将在保存到数据库时转换为MongoDate对象。如果您希望在非默认日期字段上使用此功能，您需要手动指定它们，具体方法如下：https://laravel.net.cn/docs/eloquent#date-mutators

示例

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $dates = ['birthday'];

}

允许您执行以下查询

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

关系

支持的关系有

• hasOne
• hasMany
• belongsTo
• belongsToMany
• embedsOne
• embedsMany

示例

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

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

}

和它的逆关系

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class Item extends Eloquent {

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

}

belongsToMany关系不会使用中继“表”，而是将id推送到一个related_ids属性。这使得belongsToMany方法的第二个参数变得无用。如果您想为您的关联定义自定义键，请将其设置为null

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

    public function groups()
    {
        return $this->belongsToMany('Group', null, 'user_ids', 'group_ids');
    }

}

其他关系尚不支持，但将来可能添加。有关这些关系的更多信息，请参阅https://laravel.net.cn/docs/eloquent#relationships

嵌套Many关系

如果您想嵌入模型而不是引用它们，可以使用embedsMany关系。这种关系与hasMany关系类似，但将模型嵌入到父对象中。

记住：这些关系返回Eloquent集合，它们不返回查询构建器对象！

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

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

}

您可以通过动态属性访问嵌入的模型

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

逆关系自动可用，您不需要定义此反向关系。

$user = $book->user;

插入和更新嵌入的模型与hasMany关系类似

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

$user = User::first();

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

您可以使用模型的 save 方法（自版本 2.0.0 起可用）更新嵌入模型。

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

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

$book->save();

您可以通过关系上的 destroy 方法或模型上的 delete 方法删除嵌入模型（自版本 2.0.0 起可用）。

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

$book->delete();
// or
$user->books()->destroy($book);

如果您想在不对数据库进行操作的情况下添加或删除嵌入模型，可以使用 associate 和 dissociate 方法。要最终将更改写入数据库，请保存父对象。

$user->books()->associate($book);

$user->save();

与其他关系类似，embedsMany 基于模型名称假定关系的本地键。您可以通过向 embedsMany 方法传递第二个参数来覆盖默认的本地键。

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

嵌入关系将返回嵌入项的集合，而不是查询构建器。有关可用的操作，请参阅此处：[https://laravel.net.cn/docs/master/collections](https://laravel.net.cn/docs/master/collections)

嵌入一对一关系

embedsOne 关系类似于 EmbedsMany 关系，但它只嵌入单个模型。

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class Book extends Eloquent {

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

}

您可以通过动态属性访问嵌入的模型

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

插入和更新嵌入模型的工作方式类似于 hasOne 关系。

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

$book = Books::first();

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

您可以使用 save 方法更新嵌入模型（自版本 2.0.0 起可用）。

$author = $book->author;

$author->name = 'Jane Doe';
$author->save();

您可以像这样用新的模型替换嵌入模型：

$newAuthor = new Author(['name' => 'Jane Doe']);
$book->author()->save($newAuthor);

MySQL 关系

如果您使用的是混合 MongoDB 和 SQL 设置，那么您很幸运！模型将根据相关模型的类型自动返回 MongoDB 或 SQL 关系。当然，如果希望这种功能双向工作，您的 SQL 模型需要使用 Jenssegers\Mongodb\Eloquent\HybridRelations 特性。请注意，此功能仅适用于 hasOne、hasMany 和 belongsTo 关系。

示例 SQL 基础用户模型

use Jenssegers\Mongodb\Eloquent\HybridRelations;

class User extends Eloquent {

    use HybridRelations;

    protected $connection = 'mysql';

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

}

和基于 MongoDB 的消息模型

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class Message extends Eloquent {

    protected $connection = 'mongodb';

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

}

原始表达式

这些表达式将被直接注入到查询中。

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

您还可以对内部 MongoCollection 对象执行原始表达式。如果在模型类上执行，它将返回模型集合。如果在查询构建器上执行，它将返回原始响应。

// 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();
});

可选：如果您没有向 raw 方法传递闭包，则可以访问内部 MongoCollection 对象。

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

可以通过这种方式访问内部 MongoClient 和 MongoDB 对象：

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

MongoDB 特定操作

游标超时

为了防止 MongoCursorTimeout 异常，您可以手动设置应用于游标的超时值。

DB::collection('users')->timeout(-1)->get();

更新或插入

更新或插入文档。更新方法的附加选项直接传递给原生更新方法。

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

投影

您可以使用 project 方法对查询应用投影。

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

带分页的投影

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

推入

向数组添加项目。

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

如果您不想有重复的项目，将第三个参数设置为 true。

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

拉出

从数组中移除项目。

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

清除

从文档中删除一个或多个字段。

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

您还可以对模型执行清除操作。

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

查询缓存

您可以使用 remember 方法轻松缓存查询的结果。

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

来自：[https://laravel.net.cn/docs/queries#caching-queries](https://laravel.net.cn/docs/queries#caching-queries)

查询日志

默认情况下，Laravel 会为当前请求记录所有已运行的查询。然而，在某些情况下，例如当插入大量行时，这可能导致应用程序使用过多的内存。要禁用日志，可以使用 disableQueryLog 方法。

DB::connection()->disableQueryLog();

来自：[https://laravel.net.cn/docs/database#query-logging](https://laravel.net.cn/docs/database#query-logging)