README

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

安装

请确保已安装Couchbase PHP驱动。您可以在以下位置找到安装说明：[http://developer.couchbase.com/documentation/server/current/sdk/php/start-using-sdk.html](http://developer.couchbase.com/documentation/server/current/sdk/php/start-using-sdk.html)

使用Composer安装

composer require developermarshak/laravel-couchbase

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

sonrac\Couchbase\CouchbaseServiceProvider::class,

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

$app->register(sonrac\Couchbase\CouchbaseServiceProvider::class);

$app->withEloquent();

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

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

$capsule->getDatabaseManager()->extend('couchbase', function($config)
{
    return new sonrac\Couchbase\Connection($config);
});

配置

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

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

并添加一个新的Couchbase连接

'couchbase' => [
    'driver'   => 'couchbase',
    'host'     => env('DB_HOST', 'localhost'),
    'port'     => env('DB_PORT', 8091),
    'bucket'   => env('DB_DATABASE'),
    'username' => env('DB_USERNAME'),
    'n1ql_hosts' => [
        'http://'.env('DB_HOST', 'localhost').':8093'
    ]
],

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

'couchbase' => [
    'driver'   => 'couchbase',
    'host'     => ['host1', 'host2'],
    'port'     => env('DB_PORT', 8091),
    'bucket'   => env('DB_DATABASE'),
    'username' => env('DB_USERNAME'),
    'n1ql_hosts' => [
        'http://host1:8093',
        'http://host2:8093'
    ]
],

Eloquent

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

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class User extends Eloquent {}

由于Couchbase不提供表的概念，因此文档将通过一个名为 _type 的属性来定义。与原始Eloquent一样，类的低字母复数名称将用作“表”名称，并将其放置在每个文档的 _type 属性中。

您可以通过在模型上定义 table 属性来指定自定义类型（表的别名）

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class User extends Eloquent {

    protected $table = 'my_users';

}

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

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class MyModel extends Eloquent {

    protected $connection = 'couchbase';

}

其余部分（应该）与原始Eloquent模型一样工作。有关Eloquent的更多信息，请参阅 [https://laravel.net.cn/docs/eloquent](https://laravel.net.cn/docs/eloquent)

可选：别名

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

'CouchbaseModel'       => 'sonrac\Couchbase\Eloquent\Model',

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

class MyModel extends CouchbaseModel {}

查询构建器

数据库驱动程序直接集成到原始查询构建器中。当使用Couchbase连接时，您将能够构建流畅的查询以执行数据库操作。

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

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

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

$user = DB::connection('couchbase')->table('users')->get();

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

模式

由于此Couchbase驱动程序实现为所有文档使用单个桶，因此未实现模式构建器。

示例

基本用法

检索所有模型

$users = User::all();

通过主键检索记录

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

Where子句

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

使用Where Between

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

Where null

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

按顺序排列

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

偏移量 & 限制

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

唯一

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

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

唯一可以与 where 结合使用

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

高级where

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

分组

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

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

聚合

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

类似

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

注意：Couchbase 中的 Like 检查是区分大小写的

递增或递减列的值

对指定属性执行递增或递减（默认 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 sonrac\Couchbase\Eloquent\SoftDeletes;

class User extends Eloquent {

    use SoftDeletes;

    protected $dates = ['deleted_at'];

}

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

插入、更新和删除

插入、更新和删除记录的工作方式与原始 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();

删除模型

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

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

或者通过其键删除模型

User::destroy('517c43667db388101e00000f');

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

关系

支持的关系有

hasOne
hasMany
belongsTo
belongsToMany
embedsOne
embedsMany

示例

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class User extends Eloquent {

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

}

以及反向关系

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class Item extends Eloquent {

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

}

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

use sonrac\Couchbase\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

EmbedsMany 关系

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

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

use sonrac\Couchbase\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 方法更新嵌入的模型

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

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

$book->save();

您可以通过在关系上使用 destroy 方法或在模型上使用 delete 方法来删除嵌入的模型

$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

EmbedsOne 关系

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

use sonrac\Couchbase\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方法更新嵌入的模型。

$author = $book->author;

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

您可以通过这种方式用新模型替换嵌入的模型

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

MySQL关系

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

基于SQL的用户模型示例

use sonrac\Couchbase\Eloquent\HybridRelations;

class User extends Eloquent {

    use HybridRelations;

    protected $connection = 'mysql';

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

}

以及基于Couchbase的消息模型

use sonrac\Couchbase\Eloquent\Model as Eloquent;

class Message extends Eloquent {

    protected $connection = 'couchbase';

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

}

查询缓存

您可以使用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

sonrac / laravel-couchbase

维护者

详细信息