whopoe/mongodb

由 Jens Segers 开发的 MongoDB 基于 Eloquent 模型和查询构建器的 Laravel 5 改进版本

维护者

详情

github.com/whopoe/whopoe-mongodb

主页

源代码

问题

安装: 8

依赖: 0

建议: 0

安全: 0

星星: 1

关注者: 2

分支: 0

开放问题: 0

dev-master 2016-09-14 16:39 UTC

Requires

Requires (Dev)

Suggests

MIT 137800cb84f2cf6d211149747b660e982f858814

databasemongodbmongomodellaraveleloquent

This package is not auto-updated.

Last update: 2024-09-23 13:47:19 UTC

README

Latest Stable Version Total Downloads Build Status Coverage Status Donate

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

目录

安装

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

对于 Laravel 5，使用 composer 安装最新稳定版本。

composer require jenssegers/mongodb

版本兼容性

并在 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 manager 并添加

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

配置

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

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

并添加新的 mongodb 连接

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

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

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

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');
});

支持的运算包括

  • 创建和删除
  • 集合
  • hasCollection
  • 索引和删除索引（支持复合索引）
  • 唯一
  • 后台、稀疏、过期（MongoDB 特定）

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

扩展

身份验证

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

'Jenssegers\Mongodb\Auth\PasswordResetServiceProvider',

此服务提供器会略微修改内部 DatabaseReminderRepository 以添加基于 MongoDB 的密码提醒支持。如果您不使用密码提醒，您不需要注册此服务提供器，其他所有内容都应该正常工作。

Sentry

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

会话

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

故障排除

类 'MongoClient' 在 ... 中未找到

MongoClient 类是 MongoDB PHP 驱动程序的一部分。通常，此错误意味着您忘记安装了该驱动程序，或者没有正确安装。您可以在 https://php.ac.cn/manual/en/mongo.installation.php 找到该驱动程序的安装说明。

要检查您是否已正确安装了驱动程序，请运行以下命令

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

传递给 Illuminate\Database\Query\Builder::__construct() 的第二个参数必须是 Illuminate\Database\Query\Grammars\Grammar 的实例，给定 null

要解决这个问题，您需要检查两点。首先检查您的模型是否扩展了正确的类；这个类应该是 Jenssegers\Mongodb\Eloquent\Model。其次，检查您的模型是否使用了 MongoDB 连接。如果您没有更改数据库配置文件中的默认数据库连接，您需要指定已启用 MongoDB 的连接。如果您没有设置别名并更改默认数据库连接，则您的类应该如下所示

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $connection = 'mongodb';

}

示例

基本用法

检索所有模型

$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', array(16, 18, 20))->get();

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

使用 Where Between

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

Where null

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

OrderBy

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

偏移量 & 限制

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

Distinct

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

$users = User::distinct()->get(array('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(array('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, array('group' => 'thirty something'));
User::where('bmi', 30)->decrement('bmi', 1, array('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 特定操作符

Exists

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

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

All

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

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

Size

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

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', array(10, 0))->get();

哪里

匹配满足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(array('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 = array('birthday');

}

这允许您执行以下查询

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

关系

支持的关系包括

  • hasOne
  • hasMany
  • belongsTo
  • belongsToMany

示例

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, 'users', 'groups');
    }

}

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

EmbedsMany 关系

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

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(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'))

您可以使用它们的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');

嵌入式关系将返回一个嵌入式项的集合，而不是查询构建器。为了允许更类似查询的行为，使用了修改后的Collection类，并支持以下额外的操作：

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

这允许您在集合结果上执行简单的查询。

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

注意：由于嵌入式模型不存储在单独的集合中，因此您不能查询所有嵌入式模型。您始终必须通过父模型来访问它们。

EmbedsOne 关系

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(array('name' => 'John Doe'));

$book = Books::first();

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

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

$author = $book->author;

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

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

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

MySQL 关系

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

示例基于SQL的User模型

use Jenssegers\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $connection = 'mysql';

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

}

以及基于MongoDB的Message模型

use Jenssegers\Mongodb\Eloquent\Model as Eloquent;

class Message extends Eloquent {

    protected $connection = 'mongodb';

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

}

原始表达式

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

User::whereRaw(array('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(array('age' => array('$lt' => 18)));

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

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

MongoDB 特定操作

游标超时

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

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

Upsert

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

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

投影

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

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

带有分页的投影

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

Push

向数组添加项。

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

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

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

Pull

从数组中删除项。

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

Unset

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

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

您也可以对一个模型执行 unset 操作。

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

查询缓存

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

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

来源: https://laravel.net.cn/docs/queries#caching-queries

查询日志

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

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

来源: https://laravel.net.cn/docs/database#query-logging