文化融合/mongodb

基于 MongoDB 的 Eloquent 模型和查询构建器,用于 Laravel (Moloquent)

0.1 2023-04-09 07:39 UTC

This package is auto-updated.

Last update: 2024-09-09 10:48:57 UTC


README

Latest Stable Version Total Downloads Build Status codecov Donate

此包通过使用原始 Laravel API,扩展了 MongoDB 的 Eloquent 模型和查询构建器功能。此库扩展了原始 Laravel 类,因此使用完全相同的方法。

安装

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

Laravel 版本兼容性

通过 Composer 安装包

$ composer require jenssegers/mongodb

Laravel

如果您的 Laravel 版本没有自动加载包,请将服务提供者添加到 config/app.php

Jenssegers\Mongodb\MongodbServiceProvider::class,

Lumen

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

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

$app->withEloquent();

服务提供者将在原始数据库管理器中注册一个 MongoDB 数据库扩展。无需注册其他外观或对象。

当使用 MongoDB 连接时,Laravel 将自动为您提供相应的 MongoDB 对象。

非 Laravel 项目

对于 Laravel 之外的使用,请参阅 Capsule manager 并添加

$capsule->getDatabaseManager()->extend('mongodb', function($config, $name) {
    $config['name'] = $name;

    return new Jenssegers\Mongodb\Connection($config);
});

测试

要为此包运行测试,请运行

docker-compose up

数据库测试

要测试后重置数据库,请添加

use Illuminate\Foundation\Testing\DatabaseMigrations;

同时在每个测试类内部添加

use DatabaseMigrations;

请注意,这些特质目前还不受支持

  • 使用 Database Transactions;
  • 使用 RefreshDatabase;

配置

要配置新的 MongoDB 连接,请向 config/database.php 添加新的连接条目

'mongodb' => [
    'driver' => 'mongodb',
    'dsn' => env('DB_DSN'),
    'database' => env('DB_DATABASE', 'homestead'),
],

dsn 键包含用于连接您的 MongoDB 部署的连接字符串。格式和可用选项在 MongoDB 文档 中有记录。

除了使用连接字符串之外,您还可以使用 hostport 配置选项来自动为您创建连接字符串。

'mongodb' => [
    'driver' => 'mongodb',
    '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' => [
        'appname' => 'homestead',
    ],
],

连接配置中的 options 键对应于 uriOptions 参数

Eloquent

扩展基本模型

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

use Jenssegers\Mongodb\Eloquent\Model;

class Book extends Model
{
    //
}

就像一个普通模型一样,MongoDB模型类将知道根据模型名称使用哪个集合。对于Book,将使用集合books

要更改集合,请传递$collection属性

use Jenssegers\Mongodb\Eloquent\Model;

class Book extends Model
{
    protected $collection = 'my_books_collection';
}

注意: MongoDB文档会自动存储在_id属性中存储的唯一ID。如果您想使用自己的ID,请替换$primaryKey属性,并将其设置为您的自增键属性名。

use Jenssegers\Mongodb\Eloquent\Model;

class Book extends Model
{
    protected $primaryKey = 'id';
}

// MongoDB will also create _id, but the 'id' property will be used for primary key actions like find().
Book::create(['id' => 1, 'title' => 'The Fault in Our Stars']);

同样,您可以定义一个connection属性来覆盖在利用模型时应使用的数据库连接名称。

use Jenssegers\Mongodb\Eloquent\Model;

class Book extends Model
{
    protected $connection = 'mongodb';
}

扩展Authenticatable基模型

本包包含一个MongoDB Authenticatable Eloquent类Jenssegers\Mongodb\Auth\User,您可以使用它来替换默认的Authenticatable类Illuminate\Foundation\Auth\User,用于您的User模型。

use Jenssegers\Mongodb\Auth\User as Authenticatable;

class User extends Authenticatable
{

}

软删除

当软删除模型时,它实际上并未从您的数据库中删除。相反,会在记录上设置一个deleted_at时间戳。

要为模型启用软删除,将Jenssegers\Mongodb\Eloquent\SoftDeletes trait应用到模型上

use Jenssegers\Mongodb\Eloquent\SoftDeletes;

class User extends Model
{
    use SoftDeletes;
}

有关更多信息,请参阅Laravel关于软删除的文档

保护属性

在考虑保护属性或标记某些属性为可填充时,Taylor Otwell更倾向于可填充的路径。这基于这里描述的最近的安全问题

请记住,保护仍然有效,但您可能会遇到意外的行为。

日期

Eloquent允许您使用Carbon或DateTime对象而不是MongoDate对象来工作。内部,这些日期将在保存到数据库时转换为MongoDate对象。

use Jenssegers\Mongodb\Eloquent\Model;

class User extends Model
{
    protected $casts = ['birthday' => 'datetime'];
}

这允许您执行如下查询

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

基本用法

检索所有模型

$users = User::all();

通过主键检索记录

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

Where

$posts =
    Post::where('author.name', 'John')
        ->take(10)
        ->get();

OR语句

$posts =
    Post::where('votes', '>', 0)
        ->orWhere('is_approved', true)
        ->get();

AND语句

$users =
    User::where('age', '>', 18)
        ->where('name', '!=', 'John')
        ->get();

whereIn

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

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

whereBetween

$posts = Post::whereBetween('votes', [1, 100])->get();

whereNull

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

whereDate

$users = User::whereDate('birthday', '2021-5-12')->get();

用法与whereMonth / whereDay / whereYear / whereTime相同

高级wheres

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

orderBy

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

偏移量 & 限制(跳过 & 取出)

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

groupBy

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

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

Distinct

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

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

// Equivalent to:
$users = User::distinct('name')->get();

Distinct可以与where结合使用

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

Like

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

聚合

聚合仅适用于MongoDB版本大于2.2.x

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

聚合可以与where结合使用

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

聚合也可以用于子文档

$total = Order::max('suborder.price');

注意: 此聚合仅适用于单个子文档(如EmbedsOne),不适用于子文档数组(如EmbedsMany)。

增加/减少列的值

在指定的属性上执行增加或减少(默认1)

Cat::where('name', 'Kitty')->increment('age');

Car::where('name', 'Toyota')->decrement('weight', 50);

返回更新的对象数量

$count = User::increment('age');

您还可以指定要更新的其他列

Cat::where('age', 3)
    ->increment('age', 1, ['group' => 'Kitty Club']);

Car::where('weight', 300)
    ->decrement('weight', 100, ['latest_change' => 'carbon fiber']);

MongoDB 特定运算符

Exists

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

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

All

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

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

Size

选择数组字段为指定大小时选中的文档。

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

Regex

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

use MongoDB\BSON\Regex;

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

注意: 您还可以使用Laravel正则表达式操作。这些操作更灵活,并将自动将您的正则表达式字符串转换为MongoDB\BSON\Regex对象。

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

regexp 的逆运算

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

MongoDB 特定地理空间操作

附近

$bars = Bar::where('location', 'near', [
    '$geometry' => [
        'type' => 'Point',
        'coordinates' => [
            -0.1367563, // longitude
            51.5100913, // latitude
        ],
    ],
    '$maxDistance' => 50,
])->get();

GeoWithin

$bars = Bar::where('location', 'geoWithin', [
    '$geometry' => [
        'type' => 'Polygon',
        'coordinates' => [
            [
                [-0.1450383, 51.5069158],
                [-0.1367563, 51.5100913],
                [-0.1270247, 51.5013233],
                [-0.1450383, 51.5069158],
            ],
        ],
    ],
])->get();

GeoIntersects

$bars = Bar::where('location', 'geoIntersects', [
    '$geometry' => [
        'type' => 'LineString',
        'coordinates' => [
            [-0.144044, 51.515215],
            [-0.129545, 51.507864],
        ],
    ],
])->get();

GeoNear

您可以在 mongoDB 上进行 geoNear 查询。您不需要在模型上指定自动字段。返回的实例是一个集合。因此,您可以执行 Collection 操作。只需确保您的模型有一个 location 字段,以及一个 2ndSphereIndex。在 location 字段中的数据必须保存为 GeoJSONlocation 点必须保存为用于几何计算的 WGS84 参考系。这意味着,基本上,您需要按顺序保存 经度和纬度,然后找到具有计算距离的附近点,您需要 以相同的方式进行操作

Bar::find("63a0cd574d08564f330ceae2")->update(
    [
        'location' => [
            'type' => 'Point',
            'coordinates' => [
                -0.1367563,
                51.5100913
            ]
        ]
    ]
);
$bars = Bar::raw(function ($collection) {
    return $collection->aggregate([
        [
            '$geoNear' => [
                "near" => [ "type" =>  "Point", "coordinates" =>  [-0.132239, 51.511874] ],
                "distanceField" =>  "dist.calculated",
                "minDistance" =>  0,
                "maxDistance" =>  6000,
                "includeLocs" =>  "dist.location",
                "spherical" =>  true,
            ]
        ]
    ]);
});

插入、更新和删除

插入、更新和删除记录的工作方式与原始 Eloquent 相同。请查看 Laravel 文档的 Eloquent 部分

在这里,只指定了 MongoDB 特定的操作。

MongoDB 特定操作

原始表达式

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

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

User::whereRaw([
    '$where' => '/.*123.*/.test(this.field)',
])->get();

User::whereRaw([
    '$where' => '/.*123.*/.test(this["hyphenated-field"])',
])->get();

您也可以对内部 MongoCollection 对象执行原始表达式。如果它在模型类上执行,它将返回一个模型集合。

如果它在查询构建器上执行,它将返回原始响应。

游标超时

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

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

Upsert

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

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

// Eloquent
$user->update($data, ['upsert' => true]);

投影

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

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

DB::collection('items')
    ->project(['tags' => ['$slice' => [3, 7]]])
    ->get();

分页的投影

$limit = 25;
$projections = ['id', 'name'];

DB::collection('items')
    ->paginate($limit, $projections);

Push

向数组中添加项。

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

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

$user->push('messages', [
    'from' => 'Jane Doe',
    'message' => 'Hi John',
]);

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

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

$user->push('items', 'boots', true);

Pull

从数组中删除项。

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

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

$user->pull('messages', [
    'from' => 'Jane Doe',
    'message' => 'Hi John',
]);

Unset

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

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

$user->unset('note');

关系

基本用法

唯一可用的关系是

  • hasOne
  • hasMany
  • belongsTo
  • belongsToMany

MongoDB 特定的关系是

  • embedsOne
  • embedsMany

以下是一个小示例

use Jenssegers\Mongodb\Eloquent\Model;

class User extends Model
{
    public function items()
    {
        return $this->hasMany(Item::class);
    }
}

hasMany 的逆向关系是 belongsTo

use Jenssegers\Mongodb\Eloquent\Model;

class Item extends Model
{
    public function user()
    {
        return $this->belongsTo(User::class);
    }
}

belongsToMany 和转置

belongsToMany 关系不会使用“转置”表,而是将 id 推送到 related_ids 属性中。这使得 belongsToMany 方法的第二个参数变得无用。

如果您想为关系定义自定义键,请将其设置为 null

use Jenssegers\Mongodb\Eloquent\Model;

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

嵌套多个关系

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

记住:这些关系返回 Eloquent 集合,它们不返回查询构建器对象!

use Jenssegers\Mongodb\Eloquent\Model;

class User extends Model
{
    public function books()
    {
        return $this->embedsMany(Book::class);
    }
}

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

$user = User::first();

foreach ($user->books as $book) {
    //
}

逆向关系是自动 魔法 可用的。您不需要定义此反向关系。

$book = Book::first();

$user = $book->user;

插入和更新嵌入的模型与 hasMany 关系的工作方式相似

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

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

// Similar operation
$user->books()->destroy($book);

如果您想添加或删除嵌入式模型,而不接触数据库,可以使用 associatedissociate 方法。

要最终将更改写入数据库,请保存父对象

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

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

use Jenssegers\Mongodb\Eloquent\Model;

class User extends Model
{
    public function books()
    {
        return $this->embedsMany(Book::class, 'local_key');
    }
}

嵌入式关系将返回一个包含嵌入式项的集合,而不是查询构建器。在此处查看可用的操作:https://laravel.net.cn/docs/master/collections

嵌套一个关系

embedsOne 关系类似于 embedsMany 关系,但只嵌入单个模型。

use Jenssegers\Mongodb\Eloquent\Model;

class Book extends Model
{
    public function author()
    {
        return $this->embedsOne(Author::class);
    }
}

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

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

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

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

// Similar
$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);

查询构建器

基本用法

数据库驱动程序直接插入到原始查询构建器中。

当使用 MongoDB 连接时,您将能够构建流畅的查询以执行数据库操作。

为了方便起见,还有 collection 别名用于 table,以及一些额外的 MongoDB 专用运算符/操作。

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

$hungerGames =
    DB::collection('books')
        ->where('name', 'Hunger Games')
        ->first();

如果您熟悉 Eloquent 查询,则具有相同的功能。

可用操作

要查看可用的操作,请查看 Eloquent 部分。

事务

事务需要 MongoDB 版本 ^4.0 以及副本集或分片集群的部署。您可以在 MongoDB 文档中找到更多信息 在此处

基本用法

DB::transaction(function () {
    User::create(['name' => 'john', 'age' => 19, 'title' => 'admin', 'email' => 'john@example.com']);
    DB::collection('users')->where('name', 'john')->update(['age' => 20]);
    DB::collection('users')->where('name', 'john')->delete();
});
// begin a transaction
DB::beginTransaction();
User::create(['name' => 'john', 'age' => 19, 'title' => 'admin', 'email' => 'john@example.com']);
DB::collection('users')->where('name', 'john')->update(['age' => 20]);
DB::collection('users')->where('name', 'john')->delete();

// commit changes
DB::commit();

要中止事务,请在事务期间的任何时候调用 rollBack 方法

DB::beginTransaction();
User::create(['name' => 'john', 'age' => 19, 'title' => 'admin', 'email' => 'john@example.com']);

// Abort the transaction, discarding any data created as part of it
DB::rollBack();

注意: MongoDB 中的事务不能嵌套。DB::beginTransaction() 函数将在新创建或现有会话中启动新事务,并在存在事务时引发 RuntimeException。更多信息请参阅 MongoDB 官方文档 事务和会话

DB::beginTransaction();
User::create(['name' => 'john', 'age' => 20, 'title' => 'admin']);

// This call to start a nested transaction will raise a RuntimeException
DB::beginTransaction();
DB::collection('users')->where('name', 'john')->update(['age' => 20]);
DB::commit();
DB::rollBack();

模式

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

基本用法

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

您还可以将 MongoDB 文档中指定的所有参数传递给 $options 参数

Schema::create('users', function ($collection) {
    $collection->index(
        'username',
        null,
        null,
        [
            'sparse' => true,
            'unique' => true,
            'background' => true,
        ]
    );
});

继承的操作

  • 创建和删除
  • 集合
  • hasCollection
  • 索引和删除索引(支持复合索引)
  • 唯一

MongoDB 特定操作

  • 后台
  • 稀疏
  • 过期
  • 地理空间

所有其他(不受支持)操作都作为虚拟透传方法实现,因为 MongoDB 不使用预定义的模式。

有关模式构建器的更多信息,请参阅 Laravel 文档

地理空间索引

地理空间索引非常适合查询基于位置的文档。

它们有两种形式:2d2dsphere。使用模式构建器将这些添加到集合中。

Schema::create('bars', function ($collection) {
    $collection->geospatial('location', '2d');
});

要添加 2dsphere 索引

Schema::create('bars', function ($collection) {
    $collection->geospatial('location', '2dsphere');
});

扩展

跨数据库关系

如果您使用的是混合 MongoDB 和 SQL 设置,则可以在它们之间定义关系。

模型将自动根据相关模型的类型返回 MongoDB 相关或 SQL 相关的关系。

如果您想使此功能双向工作,则您的 SQL 模型需要使用 Jenssegers\Mongodb\Eloquent\HybridRelations 特性。

此功能仅适用于 hasOnehasManybelongsTo

MySQL 模型应使用 HybridRelations 特性

use Jenssegers\Mongodb\Eloquent\HybridRelations;

class User extends Model
{
    use HybridRelations;

    protected $connection = 'mysql';

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

在您的 MongoDB 模型中,您应定义关系

use Jenssegers\Mongodb\Eloquent\Model;

class Message extends Model
{
    protected $connection = 'mongodb';

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

认证

如果您想使用 Laravel 的原生 Auth 功能,请注册此包含的服务提供程序

Jenssegers\Mongodb\Auth\PasswordResetServiceProvider::class,

此服务提供程序将稍微修改内部 DatabaseReminderRepository 以添加对基于 MongoDB 的密码提醒的支持。

如果您不使用密码提示功能,则无需注册此服务提供商,其他功能也应正常工作。

队列

如果您想使用MongoDB作为数据库后端,请在config/queue.php中更改驱动程序。

'connections' => [
    'database' => [
        'driver' => 'mongodb',
        // You can also specify your jobs specific database created on config/database.php
        'connection' => 'mongodb-job',
        'table' => 'jobs',
        'queue' => 'default',
        'expire' => 60,
    ],
],

如果您想使用MongoDB处理失败的任务,请在config/queue.php中更改数据库。

'failed' => [
    'driver' => 'mongodb',
    // You can also specify your jobs specific database created on config/database.php
    'database' => 'mongodb-job',
    'table' => 'failed_jobs',
],

Laravel 特定

config/app.php中添加服务提供商。

Jenssegers\Mongodb\MongodbQueueServiceProvider::class,

Lumen 特定

在使用Lumen时,请在bootstrap/app.php中添加服务提供商。然而,您必须确保在添加以下内容后添加MongodbServiceProvider注册。

$app->make('queue');

$app->register(Jenssegers\Mongodb\MongodbQueueServiceProvider::class);

升级

从版本 2 升级到 3

在这个新的大版本中,它支持新的MongoDB PHP扩展,我们还将Model类的位置移动了,并用trait替换了MySQL模型类。

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

use Jenssegers\Mongodb\Eloquent\Model;

class User extends Model
{
    //
}

如果您使用的是混合关系,现在您的MySQL类应扩展原始的Eloquent模型类Illuminate\Database\Eloquent\Model,而不是已删除的Jenssegers\Eloquent\Model

而是使用新的Jenssegers\Mongodb\Eloquent\HybridRelations trait。这应该使事情更加清晰,因为在这个包中只有一个单独的模型类。

use Jenssegers\Mongodb\Eloquent\HybridRelations;

class User extends Model
{

    use HybridRelations;

    protected $connection = 'mysql';
}

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

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

安全联系方式

要报告安全漏洞,请遵循这些步骤