README

NeoEloquent

Neo4j 图 Eloquent 驱动程序 for Laravel

聊天 & 支持

加入官方 Neo4j Slack 群组并使用 #neo4j-php 频道。

快速参考

安装
配置
模型
关系
边
迁移
模式
聚合
仅限于 Neo
要避免的事情

安装

将包添加到您的 composer.json 并运行 composer update。

Laravel 5

5.4

{
    "require": {
        "denisgold/neoeloquent": "1.5.*"
    }
}

5.3

{
    "require": {
        "denisgold/neoeloquent": "1.4.*"
    }
}

5.2

{
    "require": {
        "denisgold/neoeloquent": "1.3.*"
    }
}

5.1

{
    "require": {
        "denisgold/neoeloquent": "1.2.*"
    }
}

5.0

{
    "require": {
        "denisgold/neoeloquent": "1.2.5"
    }
}

Laravel 4

{
    "require": {
        "denisgold/neoeloquent": "1.1.*"
    }
}

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

'Vinelab\NeoEloquent\NeoEloquentServiceProvider',

服务提供者将注册此包所需的所有类，并将 Model 类别别名为 NeoEloquent，这样您就可以在模型中简单地进行 extend NeoEloquent。

配置

连接

在 app/config/database.php 中或基于环境的配置 app/config/[env]/database.php 中，将 neo4j 设置为默认连接

'default' => 'neo4j',

添加连接默认值

'connections' => [
    'neo4j' => [
        'driver' => 'neo4j',
        'host'   => 'localhost',
        'port'   => '7474',
        'username' => null,
        'password' => null
    ]
]

Lumen

对于 Lumen，您需要在应用根目录下创建一个名为 config 的新文件夹，并在其中添加一个名为 database.php 的文件。在那里，您将添加以下代码。

<?php

return ['connections' => [
            'neo4j' => [
                'driver' => 'neo4j',
                'host'   => 'localhost',
                'port'   => '7474',
                'username' => null,
                'password' => null
            ]
        ]
    ];

并在 bootstrap/app.php 中添加以下行

$app->configure('database');

这是为了使 Lumen 能够读取除提供的默认配置以外的其他配置。

在添加服务提供者时，您必须在 bootstrap/app.php 的 Register Providers 部分中添加它。您可以如此添加

$app->register('Vinelab\NeoEloquent\NeoEloquentServiceProvider');

迁移设置

如果您愿意使用迁移

创建 app/database/labels 文件夹
修改 composer.json 并将 app/database/labels 添加到 classmap 数组中
运行 composer dump-autoload

文档

class User extends NeoEloquent {}

NeoEloquent 如此简单，将根据类名生成默认节点标签，在本例中将是 :User。有关节点标签的信息

命名空间模型

当您在模型中使用命名空间时，标签将考虑完整的命名空间。

namespace Vinelab\Cms;

class Admin extends NeoEloquent { }

从该关系生成的标签将是 VinelabCmsAdmin，这是为了确保在引入另一个 Admin 实例（如 Vinelab\Blog\Admin）时，标签不会发生冲突，数据库中的 :Admin 将变得混乱。

自定义节点标签

您可以指定希望使用的标签（而不是默认生成的标签），它们也是大小写敏感的，因此将按此处存储的方式存储。

class User extends NeoEloquent {

    protected $label = 'User'; // or array('User', 'Fan')

    protected $fillable = ['name', 'email'];
}

$user = User::create(['name' => 'Some Name', 'email' => 'some@email.com']);

NeoEloquent 对 $table 变量的回退支持，如果找到并且模型上没有定义 $label，则会使用它。

class User extends NeoEloquent {

    protected $table = 'User';

}

请勿担心标签格式，您可以使用 array('Label1', 'Label2') 或用冒号分隔它们，并可选地在前面加上冒号。

软删除

Laravel 5

要启用软删除，您需要使用 use Vinelab\NeoEloquent\Eloquent\SoftDeletes 而不是 Illuminate\Database\Eloquent\SoftDeletes，并且就像 Eloquent 一样，您需要在模型中添加 $dates，如下所示

use Vinelab\NeoEloquent\Eloquent\SoftDeletes;

class User extends NeoEloquent {

    use SoftDeletes;

    protected $dates = ['deleted_at'];

}

Laravel 4

要启用软删除，您需要使用 use Vinelab\NeoEloquent\Eloquent\SoftDeletingTrait 而不是 Illuminate\Database\Eloquent\SoftDeletingTrait，并且就像 Eloquent 一样，您需要在模型中添加 $dates，如下所示

use Vinelab\NeoEloquent\Eloquent\SoftDeletingTrait;

class User extends NeoEloquent {

    use SoftDeletingTrait;

    protected $dates = ['deleted_at'];

}

关系

一对一
一对多
多对多
多态

让我们通过一些节点之间关系示例。

一对一

class User extends NeoEloquent {

    public function phone()
    {
        return $this->hasOne('Phone');
    }

这表示从 :User 节点到 :Phone 的 OUTGOING 关系方向。

保存

$phone = new Phone(['code' => 961, 'number' => '98765432'])
$relation = $user->phone()->save($phone);

此语句执行的Cypher查询如下

MATCH (user:`User`)
WHERE id(user) = 1
CREATE (user)-[:PHONE]->(phone:`Phone` {code: 961, number: '98765432', created_at: 7543788, updated_at: 7543788})
RETURN phone;

定义此关系的逆关系

class Phone extends NeoEloquent {

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

这代表从:User节点到该:Phone节点的INCOMING关系方向。

关联模型

由于我们不处理外键，在这种情况下，它不仅仅是设置父模型的外键属性。在Neo4j（以及图数据库）中，关系本身就是一个实体，也可以有自己的属性，因此引入了边

注意：关联模型在调用associate()时不会自动持久化关系。

$account = Account::find(1986);

// $relation will be Vinelab\NeoEloquent\Eloquent\Edges\EdgeIn
$relation = $user->account()->associate($account);

// Save the relation
$relation->save();

此语句执行的Cypher查询如下

MATCH (account:`Account`), (user:`User`)
WHERE id(account) = 1986 AND id(user) = 9862
MERGE (account)<-[rel_user_account:ACCOUNT]-(user)
RETURN rel_user_account;

一对多

class User extends NeoEloquent {

    public function posts()
    {
        return $this->hasMany('Post', 'POSTED');
    }
}

这代表从:User节点到:Post节点的OUTGOING关系方向。

$user = User::find(1);
$post = new Post(['title' => 'The Title', 'body' => 'Hot Body']);
$user->posts()->save($post);

与One-To-One关系类似，从save()语句返回的值是一个Edge[In|Out]

此语句执行的Cypher查询如下

MATCH (user:`User`)
WHERE id(user) = 1
CREATE (user)-[rel_user_post:POSTED]->(post:`Post` {title: 'The Title', body: 'Hot Body', created_at: '15-05-2014', updated_at: '15-05-2014'})
RETURN rel_user_post;

定义此关系的逆关系

class Post extends NeoEloquent {

    public function author()
    {
        return $this->belongsTo('User', 'POSTED');
    }
}

这代表从:User节点到该:Post节点的INCOMING关系方向。

多对多

class User extends NeoEloquent {

    public function followers()
    {
        return $this->belongsToMany('User', 'FOLLOWS');
    }
}

这代表一个:User节点与另一个:User节点之间的INCOMING关系。

$jd = User::find(1012);
$mc = User::find(1013);

$jd关注$mc

$jd->followers()->save($mc);

或者使用attach()方法

$jd->followers()->attach($mc);
// Or..
$jd->followers()->attach(1013); // 1013 being the id of $mc ($mc->getKey())

此语句执行的Cypher查询如下

MATCH (user:`User`), (followers:`User`)
WHERE id(user) = 1012 AND id(followers) = 1013
CREATE (followers)-[:FOLLOWS]->(user)
RETURN rel_follows;

$mc回关注$jd

$mc->followers()->save($jd);

此语句执行的Cypher查询如下

MATCH (user:`User`), (followers:`User`)
WHERE id(user) = 1013 AND id(followers) = 1012
CREATE (user)-[rel_user_followers:FOLLOWS]->(followers)
RETURN rel_follows;

获取$jd的关注者

$followers = $jd->followers;

此语句执行的Cypher查询如下

MATCH (user:`User`), (followers:`User`), (user)-[rel_user_followers:FOLLOWS]-(followers)
WHERE id(user) = 1012
RETURN rel_follows;

动态属性

class Phone extends NeoEloquent {

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

}

$phone = Phone::find(1006);
$user = $phone->user;
// or getting an attribute out of the related model
$name = $phone->user->name;

多态

多态关系的概念与骨的关系纯粹是关系性的，但当涉及到图时，我们将其表示为超边。

超边涉及三个模型，即父模型、超模型和相关模型，如下图所示

在代码中，这将通过以下三个模型User、Comment和Post表示，其中id为1的User发布了一个Post，而id为6的User对那个Post上的Comment进行了评论，如下所示

class User extends NeoEloquent {

    public function comments($morph = null)
    {
        return $this->hyperMorph($morph, 'Comment', 'COMMENTED', 'ON');
    }

}

为了使事情简单，但仍涉及三个模型，我们不得不传递一个$morph，它可以是任何commentable模型，在我们的案例中，它可以是Video或Post模型。

注意：请确保将其默认设置为null，这样我们就可以通过$user->comments动态或预加载。

使用create()方法创建一个Comment。

$user = User::find(6);
$post = Post::find(2);

$user->comments($post)->create(['text' => 'Totally agree!', 'likes' => 0, 'abuse' => 0]);

像往常一样，我们将返回一个边，但这次它不是有方向的，它是一个HyperEdge的实例，更多关于HyperEdges的信息请参阅这里。

或者你可以保存一个Comment实例

$comment = new Comment(['text' => 'Magnificent', 'likes' => 0, 'abuse' => 0]);

$user->comments($post)->save($comment);

还支持在BelongsToMany关系中找到的所有功能，如通过ID附加模型

$user->comments($post)->attach([$id, $otherId]);

或分离模型

$user->comments($post)->detach($comment); // or $comment->id

同步

$user->comments($post)->sync([$id, $otherId, $someId]);

检索多态关系

从我们之前的示例中，我们将使用Video模型来检索它们的评论

class Video extends NeoEloquent {

    public function comments()
    {
        return $this->morphMany('Comment', 'ON');
    }

}

动态加载多态模型

$video = Video::find(3);
$comments = $video->comments;

预加载多态模型

$video = Video::with('comments')->find(3);
foreach ($video->comments as $comment)
{
    //
}

检索多态关系的逆关系

class Comment extends NeoEloquent {

    public function commentable()
    {
        return $this->morphTo();
    }

}

$postComment = Comment::find(7);
$post = $comment->commentable;

$videoComment = Comment::find(5);
$video = $comment->commentable;

// You can also eager load them
Comment::with('commentable')->get();

您还可以指定要返回的morph类型

class Comment extends NeoEloquent {

    public function post()
    {
        return $this->morphTo('Post', 'ON');
    }

    public function video()
    {
        return $this->morphTo('Video', 'ON');
    }

}

简短的多态关系

为了深入了解，以下是涉及多态关系的三个模型如何连接

class User extends NeoEloquent {

    public function comments($morph = null)
    {
        return $this->hyperMorph($morph, 'Comment', 'COMMENTED', 'ON');
    }

}

class Post extends NeoEloquent { // Video is the same as this one

    public function comments()
    {
        return $this->morphMany('Comment', 'ON');
    }

}

class Comment extends NeoEloquent {

    public function commentable()
    {
        return $this->morphTo();
    }

}

预加载

class Book extends NeoEloquent {

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

以尽可能低的开销加载作者及其书籍

foreach (Book::with('author')->get() as $book)
{
    echo $book->author->name;
}

循环上方将只运行两个Cypher查询

MATCH (book:`Book`) RETURN *;

MATCH (book:`Book`), (book)<-[:WROTE]-(author:`Author`) WHERE id(book) IN [1, 2, 3, 4, 5, ...] RETURN book, author;

边

EdgeIn
EdgeOut
HyperEdge
处理边
边属性

介绍

由于图中的关系与其他数据库类型有很大不同，因此我们必须相应地处理它们。关系具有方向，可以是相对于父节点的In和Out。

EdgeIn

代表从相关模型到父模型的INCOMING方向关系。

class Location extends NeoEloquent {

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

}

将一个 用户 与一个 位置 相关联

$location = Location::find(1922);
$user = User::find(3876);
$relation = $location->associate($user);

在Cypher领域中，这会映射为 (:Location)<-[:LOCATED_AT]-(:User)，其中 $relation 是一个代表对父节点关系的 EdgeIn 实例。

您仍然可以访问边缘模型

$relation = $location->associate($user);
$location = $relation->parent();
$user = $relation->related();

EdgeOut

表示从父模型到相关模型的 OUTGOING 方向关系。

class User extends NeoEloquent {

    public function posts()
    {
        return $this->hasMany('Post', 'POSTED');
    }

}

要将从 :User 到 :Post 的输出边缘保存起来，它将如下所示

$post = new Post(['...']);
$posted = $user->posts()->save($post);

在Cypher中，它将是 (:User)-[:POSTED]->(:Post)，其中 $posted 是 EdgeOut 实例。

并获取相关模型

$edge = $user->posts()->save($post);
$user = $edge->parent();
$post = $edge->related();

HyperEdge

此边缘是作为表示涉及两个其他边缘（左和右）的多态关系的结果，这些边缘可以通过 left() 和 right() 方法访问。

与其他边缘相比，此边缘的处理略有不同，因为它不是两个模型之间的直接关系，这意味着它没有特定的方向。

$edge = $user->comments($post)->attach($comment);
// Access the left and right edges
$left = $edge->left();
$user = $left->parent();
$comment = $left->related();

$right = $edge->right();
$comment = $right->parent();
$post = $right->related();

与边缘一起工作

如前所述，与 SQL 中的外键不同，在图数据库中边缘是实体，在 Documents 中它们是嵌入或id作为引用。因此，我们将其开发为 轻量级模型，这意味着您可以像处理 Eloquent 实例一样处理它们 - 在一定程度上，除了 HyperEdges。

// Create a new relationship
$relation = $location->associate($user); // Vinelab\NeoEloquent\Eloquent\Edges\EdgeIn

// Save the relationship to the database
$relation->save(); // true

在 HyperEdge 的情况下，您可以如下访问所有三个模型

$edge    = $user->comments($post)->save($comment);
$user    = $edge->parent();
$comment = $edge->hyper();
$post    = $edge->related();

边属性

默认情况下，边缘将自动设置并更新时间戳 created_at 和 updated_at，但前提是必须通过在父模型上将 $timestamps 设置为 true 启用时间戳。

$located_at = $location->associate($user);
$located_at->since = 1966;
$located_at->present = true;
$located_at->save();

// $created_at and $updated_at are Carbon\Carbon instances
$created_at = $located_at->created_at;
$updated_at = $located_at->updated_at;

从关系检索边缘

与创建一个关联会创建一个 EdgeIn 关系的方式一样，我们可以通过在 belongsTo 关系上调用 edge($model) 方法来检索两个模型之间的边缘。

$location = Location::find(1892);
$edge = $location->user()->edge();

您还可以指定边缘另一侧的模型。

注意：默认情况下，NeoEloquent 将尝试内部执行 $location->user 来根据关系函数名称确定边缘的相关侧，在这种情况下是 user()。

$location = Location::find(1892);
$edge = $location->user()->edge($location->user);

仅限于 Neo

createWith

在这里，您将找到NeoEloquent特定的方法和实现，与Eloquent的出色方法结合使用，可以让您在图和Neo4j上工作得非常愉快！

createWith

创建关系
附加关系

此方法会在关系型数据库和文档数据库之间“填补”空白，它允许通过一次数据库请求创建多个相关模型。

创建新记录和关系

以下是一个创建带有附加照片和视频的帖子的示例

class Post extends NeoEloquent {

    public function photos()
    {
        return $this->hasMany('Photo', 'PHOTO');
    }

    public function videos()
    {
        return $this->hasMany('Video', 'VIDEO');
    }
}

Post::createWith(['title' => 'the title', 'body' => 'the body'], [
    'photos' => [
        [
            'url'      => 'http://url',
            'caption'  => '...',
            'metadata' => '...'
        ],
        [
            'url' => 'http://other.url',
            'caption' => 'the bay',
            'metadata' => '...'
        ]
    ],

    'videos' => [
        'title' => 'Boats passing us by',
        'description' => '...'
    ]
]);

键 photos 和 videos 必须与 Post 模型中关系方法名称相同。

上述示例执行了以下Cypher查询

CREATE (post:`Post` {title: 'the title', body: 'the body'}),
(post)-[:PHOTO]->(:`Photo` {url: 'http://url', caption: '...', metadata: '...'}),
(post)-[:PHOTO]->(:`Photo` {url: 'http://other', caption: 'the bay', metadata: '...'}),
(post)-[:VIDEO]->(:`Video` {title: 'Boats passing us by', description: '...'});

我们将得到创建的节点及其关系如下

您还可以将模型和属性作为关系值混合，但不是必需的，因为NeoEloquent将通过 $fillable 过滤器管道传递提供的属性

$videos = new Video(['title' => 'foo', 'description' => 'bar']);
Post::createWith($info, compact('videos'));

您还可以使用单个数组属性如下

class User extends NeoEloquent {

    public function account()
    {
        return $this->hasOne('Account');
    }
}

User::createWith(['name' => 'foo'], ['account' => ['guid' => 'bar', 'email' => 'some@mail.net']]);

将现有记录作为关系附加

createWith 足够智能，可以知道您传递现有模型、模型ID或需要创建的新记录之间的区别，这允许混合新记录和现有记录。

class Post extends NeoEloquent {

    public function tags()
    {
        return $this->hasMany('Tag', 'TAG');
    }
}

$tag1 = Tag::create(['title' => 'php']);
$tag2 = Tag::create(['title' => 'dev']);

$post = Post::createWith(['title' => 'foo', 'body' => 'bar'], ['tags' => [$tag1, $tag2]]);

然后我们将得到与现有 Tag 节点相关联的 Post。

或者使用模型的 id

Post::createWith(['title' => 'foo', 'body' => 'bar'], ['tags' => 1, 'privacy' => 2]);

关联记录的查询Cypher语句将是

CREATE (post:`Post` {title: 'foo', 'body' => 'bar'})
WITH post
MATCH (tag:`Tag`)
WHERE id(tag) IN [1, 2]
CREATE (post)-[:TAG]->(tag);

迁移

为了使迁移工作，请执行以下操作

创建 app/database/labels 文件夹
修改 composer.json 并将 app/database/labels 添加到 classmap 数组中

由于Neo4j是一个无模式的数据库，您不需要为标签预先定义属性类型。但是，您可以使用NeoEloquent的简单索引和约束。

命令

NeoEloquent在neo4j命名空间下引入了新的命令，因此您仍然可以并行使用Eloquent的迁移命令。

迁移命令与Eloquent相同，形式为neo4j:migrate[:command]

neo4j:make:migration                 Create a new migration file
neo4j:migrate                        Run the database migrations
neo4j:migrate:reset                  Rollback all database migrations
neo4j:migrate:refresh                Reset and re-run all migrations
neo4j:migrate:rollback               Rollback the last database migration

创建迁移

与Laravel类似，您可以使用Artisan的make命令创建一个新的迁移。

php artisan neo4j:migrate:make create_user_label

标签迁移将放置在app/database/labels

您可以向命令添加额外的选项，例如

php artisan neo4j:migrate:make foo --path=app/labels
php artisan neo4j:migrate:make create_user_label --create=User
php artisan neo4j:migrate:make create_user_label --label=User

运行迁移

运行所有待处理的迁移

php artisan neo4j:migrate

运行路径的所有待处理迁移

php artisan neo4j:migrate --path=app/foo/labels

运行包的所有待处理迁移

php artisan neo4j:migrate --package=vendor/package

注意：如果在运行迁移时收到“类未找到”错误，请尝试运行composer dump-autoload命令。

在生产中强制运行迁移

要强制在生产数据库上运行迁移，可以使用

php artisan neo4j:migrate --force

回滚迁移

回滚最后迁移操作

php artisan neo4j:migrate:rollback

回滚所有迁移

php artisan neo4j:migrate:reset

回滚所有迁移并再次运行它们

php artisan neo4j:migrate:refresh

php artisan neo4j:migrate:refresh --seed

模式

NeoEloquent会自动为使用标签而别名Neo4jSchema外观。

Neo4jSchema::label('User', function(Blueprint $label)
{
    $label->unique('uuid');
});

如果您决定手动编写迁移类（不使用生成器），请确保有这些use语句

use Vinelab\NeoEloquent\Schema\Blueprint;
use Vinelab\NeoEloquent\Migrations\Migration;

目前，Neo4j支持属性上的UNIQUE约束和INDEX。您可以在以下位置了解更多信息：

http://docs.neo4j.org/chunked/stable/graphdb-neo4j-schema.html

模式方法

删除标签

Neo4jSchema::drop('User');
Neo4jSchema::dropIfExists('User');

重命名标签

Neo4jSchema::renameLabel($from, $to);

检查标签存在性

if (Neo4jSchema::hasLabel('User')) {

} else {

}

检查关系存在性

if (Neo4jSchema::hasRelation('FRIEND_OF')) {

} else {

}

您可以在以下位置了解更多关于迁移和模式的信息：

https://laravel.net.cn/docs/schema

https://laravel.net.cn/docs/migrations

聚合

除了Eloquent构建器聚合之外，NeoEloquent还支持Neo4j特定的聚合，如percentile和standard deviation，以保持相同的函数名以便于使用。有关更多信息，请参阅文档。

table()表示模型的标签

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

$distinct = DB::table('User')->countDistinct('points');

$price = DB::table('Order')->max('price');

$price = DB::table('Order')->min('price');

$price = DB::table('Order')->avg('price');

$total = DB::table('User')->sum('votes');

$disc = DB::table('User')->percentileDisc('votes', 0.2);

$cont = DB::table('User')->percentileCont('votes', 0.8);

$deviation = DB::table('User')->stdev('sex');

$population = DB::table('User')->stdevp('sex');

$emails = DB::table('User')->collect('email');

变更日志

有关详细信息，请参阅发布。

避免

以下是一些约束和图特定的注意事项，这是一系列不受支持或不建议使用的功能。

连接 😖

对于图来说，它们没有意义，图还讨厌它们！这使得它们故意不受支持。如果您从基于SQL的应用迁移，它们将是您的噩梦。

多对多关系中的Pivot表

这不受支持，我们将使用边来处理模型之间的关系。

嵌套数组和对象

由于单个对象映射类型在单个中可以存储的限制，您永远不能在单个模型中有嵌套的数组或对象，请确保它是扁平的。示例：

// Don't
User::create(['name' => 'Some Name', 'location' => ['lat' => 123, 'lng'=> -123 ] ]);

有关如何在图中实现此操作的更多信息，请参阅createWith()方法。

测试

安装一个Neo4j实例，并使用默认配置localhost:7474运行它
确保数据库图是空的，以避免冲突
运行composer install后，应该有/vendor/bin/phpunit
在确保Neo4j实例正在运行后，运行./vendor/bin/phpunit

标记为不完整的测试意味着它们是已知问题或不受支持的特性，请检查包含的消息以获取更多信息。

denisgold / neoeloquent

维护者

详细信息

README

NeoEloquent

聊天 & 支持

快速参考

安装

Laravel 5

5.4

5.3

5.2

5.1

5.0

Laravel 4

配置

连接

Lumen

迁移设置

文档

模型

命名空间模型

自定义节点标签

软删除

Laravel 5

Laravel 4

关系

一对一

保存

定义此关系的逆关系

关联模型

一对多

定义此关系的逆关系

多对多

动态属性

多态

检索多态关系

动态加载多态模型

预加载多态模型

检索多态关系的逆关系

简短的多态关系

预加载

边

介绍

EdgeIn

EdgeOut

HyperEdge

与边缘一起工作

边属性

从关系检索边缘

仅限于 Neo

createWith

创建新记录和关系

将现有记录作为关系附加

迁移

命令

创建迁移

运行迁移

运行所有待处理的迁移

运行路径的所有待处理迁移

运行包的所有待处理迁移

在生产中强制运行迁移

回滚迁移

回滚最后迁移操作

回滚所有迁移

回滚所有迁移并再次运行它们

模式

模式方法

删除标签

重命名标签

检查标签存在性

检查关系存在性

聚合

变更日志

避免

连接 😖

多对多关系中的Pivot表

嵌套数组和对象

测试