README

NeoEloquent

Neo4j 图 Eloquent 驱动程序用于 Laravel，这是由 Vinelab/NeoEloquent 维护者 hafizshahid 的分支，因为原始仓库已不再维护。

在 hafizshahid 中，我们通常在基于 Laravel 的 SaaS 中使用 NeoEloquent 进行大量的 CRUD 操作。由于更复杂操作通常需要编写原始 cypher，因此我们不推荐使用多态关系。

聊天 & 支持

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

快速参考

安装
配置
模型
关系
边
迁移
模式
聚合
仅在 Neo 中
要避免的事项

安装

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

Laravel 6.x

6.x

{
    "require": {
        "hafizshahid/neoeloquent": "^1.4.7"
    }
}

在 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'   => env('DB_HOST', 'localhost'),
        'port'   => env('DB_PORT', '7474'),
        'username' => env('DB_USERNAME', null),
        'password' => env('DB_PASSWORD', null)
    ]
]

迁移设置

如果您愿意使用迁移

创建文件夹 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'];

}

关系

一对一
一对多
多对多
多态

让我们看看节点之间的关系示例。

一对一

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

该语句执行的反向查询将如下所示

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

该语句执行的反向查询将如下所示

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]

该语句执行的反向查询将如下所示

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

该语句执行的反向查询将如下所示

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

该语句执行的反向查询将如下所示

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;

该语句执行的反向查询将如下所示

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 动态或 eager 加载。

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

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

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

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

或者您也可以保存一个 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

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

class Location extends NeoEloquent {

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

}

将一个 User 关联到 Location。

$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

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

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 的边，可以通过 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 的应用程序迁移，它们将成为您的噩梦。

多对多关系中的交叉表

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

嵌套数组和对象

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

// 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

标记为不完整的测试意味着它们要么是已知问题，要么是非支持功能，请查看包含的消息以获取更多信息。

hafizshahid / neoeloquent

维护者

详细信息

README

NeoEloquent

聊天 & 支持

快速参考

安装

Laravel 6.x

6.x

配置

连接

迁移设置

文档

模型

命名空间模型

自定义节点标签

软删除

Laravel 5

关系

一对一

保存

定义此关系的逆关系

关联模型

一对多

定义此关系的逆关系

多对多

动态属性

多态

检索多态关系

动态加载多态模型

预加载多态模型

检索多态关系的逆关系

多态关系简述

预加载

边

介绍

EdgeIn

EdgeOut

HyperEdge

处理边

边属性

从关系检索边

仅在 Neo 中

CreateWith

创建新记录和关系

将现有记录作为关系附加

迁移

命令

创建迁移

运行迁移

运行所有挂起的迁移

运行路径的所有挂起迁移

运行包的所有挂起迁移

在生产环境中强制运行迁移

回滚迁移

回滚最后迁移操作

回滚所有迁移

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

模式

模式方法

删除标签

重命名标签

检查标签的存在性

检查关系的存在性

聚合

变更日志

避免

连接 😖

多对多关系中的交叉表

嵌套数组和对象

测试