README

企业级 Neo4j 客户端

简介

Neo4j-PHP-Client 是最先进和灵活的 Neo4j PHP 客户端。

什么是 Neo4j？

Neo4j 是一个事务性、开源的图数据库。图数据库通过连接数据结构管理数据，能够以非常便捷的方式表示任何类型的数据。信息存储在节点和连接节点的关系中，两者都可以具有任意属性。了解更多请访问什么是图数据库？

关键特性

支持多连接
支持 Bolt 二进制协议
内置并自动支持 Neo4j Enterprise HA 主从模式，并具有自动从节点回退功能

Neo4j 版本支持

Neo4j 功能支持

要求

PHP >= 5.6
ext-bcmath
ext-mbstring
Neo4j 数据库（最小版本 2.2.6）

获取帮助

您可以使用以下方式

在 StackOverflow 上提问
对于错误，请自由地在 GitHub 上创建一个新问题

实现

Symfony 框架包

安装和基本使用

安装

将库添加到您的 composer 依赖项中

composer require imoox/neo4j-php-client:^4.0

要求 composer 自动加载器，通过提供连接别名和连接设置来配置您的连接

<?php

require_once 'vendor/autoload.php';

use GraphAware\Neo4j\Client\ClientBuilder;

$client = ClientBuilder::create()
    ->addConnection('default', 'http://neo4j:password@localhost:7474') // Example for HTTP connection configuration (port is optional)
    ->addConnection('bolt', 'bolt://neo4j:password@localhost:7687') // Example for BOLT connection configuration (port is optional)
    ->build();

现在您已准备好连接到您的数据库。

注意：构建方法将处理配置设置，并返回一个 Client 实例。

基本使用

发送 Cypher 查询

$client->run('CREATE (n:Person)');

带参数的 Cypher 查询

$client->run('CREATE (n:Person) SET n += {infos}', ['infos' => ['name' => 'Ales', 'age' => 34]]);

读取结果

$result = $client->run('MATCH (n:Person) RETURN n');
// a result always contains a collection (array) of Record objects

// get all records
$records = $result->getRecords();

// get the first or (if expected only one) the only record

$record = $result->getRecord();

Record 对象包含您的 Cypher 查询中的一条记录的值

$query = 'MATCH (n:Person)-[:FOLLOWS]->(friend) RETURN n.name, collect(friend) as friends';
$result = $client->run($query);

foreach ($result->getRecords() as $record) {
    echo sprintf('Person name is : %s and has %d number of friends', $record->value('name'), count($record->value('friends')));
}

Cypher 语句和堆栈

理想情况下，您会堆叠您的语句并一次全部发出以改善性能。

您可以创建 Cypher 语句堆栈，这些堆栈充当一个包，并用客户端运行此堆栈，例如

$stack = $client->stack();

$stack->push('CREATE (n:Person {uuid: {uuid} })', ['uuid' => '123-fff']);
$stack->push('MATCH (n:Person {uuid: {uuid1} }), (n2:Person {uuid: {uuid2} }) MERGE (n)-[:FOLLOWS]->(n2)', ['uuid1' => '123-fff', 'uuid2' => '456-ddd']);

$results = $client->runStack($stack);

标记您的 Cypher 语句

有时，您可能希望从堆栈中检索特定结果，一种简单的方法是标记您的 Cypher 语句。

标记通过 run 或 push 方法的第三个参数传递

$stack = $client->stack();

$stack->push('CREATE (n:Person {uuid: {uuid} })', ['uuid' => '123-fff'], 'user_create');
$stack->push('MATCH (n:Person {uuid: {uuid1} }), (n2:Person {uuid: {uuid2} }) MERGE (n)-[r:FOLLOWS]->(n2) RETURN id(r) as relId', ['uuid1' => '123-fff', 'uuid2' => '456-ddd'], 'user_follows');

$results = $client->runStack($stack);

$followResult = $results->get('user_follows');
$followRelationshipId = $followResult->getRecord()->value('relId');

处理结果集

基础

run 方法返回一个单独的 Result 对象。您可以在预期返回多个结果的方法中找到返回 ResultCollection 对象，它是可遍历的。

Result 对象包含语句的 records 和 summary，API 中提供以下方法

$result->firstRecord(); // Returns the first record of the Statement Result

$result->records(); // Returns all records

$result->summarize(); // Returns the ResultSummary

摘要

ResultSummary 包含 Statement、统计信息和可选的查询计划

$summary = $result->summarize();

$query = $summary->statement()->text();

$stats = $summary->updateStatistics();

$nodesUpdated = $stats->nodesUpdated();
$propertiesSet = $stats->propertiesSet();

// Does the statement affected the graph ?
$affected = $stats->containsUpdates();

记录值

每个记录包含 Cypher 查询返回的一行值


$query = 'MATCH (n:Person) n, n.name as name, n.age as age';
$result = $client->run($query);

foreach ($result->records() as $record) {
    print_r($record->get('n')); // nodes returned are automatically hydrated to Node objects

    echo $record->value('name') . PHP_EOL;
    echo $record->value('age') . PHP_EOL;
}

客户端负责将图对象转换为 PHP 对象，因此对于节点、关系和路径都适用

节点

labels() : 返回一个标签数组（字符串）
identity() : 返回节点的内部 ID
values() : 返回节点的属性（数组）
value($key) : 返回给定属性键的值
hasValue($key) : 返回节点是否具有给定键的属性
keys() : 返回表示节点属性键的数组
hasLabel($label) : 返回节点是否具有给定的标签（布尔值）

关系

type() : 返回关系类型
identity() : 返回关系的内部 ID
values() : 返回关系的属性（数组）
value($key) : 返回给定属性键的值
hasValue($key) : 返回关系是否具有给定键的属性
keys() : 返回表示关系属性键的数组
startNodeIdentity : 返回起始节点 ID
endNodeIdentity : 返回终止节点 ID

路径

start() : 返回路径的起始节点
end() : 返回路径的终止节点
length() : 返回路径的长度
nodes() : 返回路径中的所有节点
relationships : 返回路径中的所有关系

处理结果（从 v3 到 v4）

关于这个主题有3个主要概念

结果
记录
记录值

让我们看看一个在浏览器中执行的查询，它包含多种类型的结果

MATCH (n:Address)
RETURN n.address as addr, n, collect(id(n)) as ids
LIMIT 5

结果

Result 是一组 Record 对象的集合，浏览器中每行的内容都是一个 Record，它包含 Record Value。

蓝色表示结果
橙色表示记录
绿色表示记录值

记录

与客户端的先前版本不同，不再自动将所有记录合并到一个大记录中，因此您需要迭代 Result 中的所有记录

$query = 'MATCH (n:Address)
RETURN n.address as addr, n, collect(id(n)) as ids
LIMIT 5';
$result = $client->run($query);

foreach ($result->records() as $record) {
  // here we do what we want with one record (one row in the browser result)
  print_r($record);
}

记录值

每个记录都包含一个由 key 标识的 Record Value 集合，该键是您在 Cypher 查询的 RETURN 子句中提供的标识符。在我们的例子中，一个 Record 将包含以下键

addr
n
ids

为了访问值，您可以在 Record 对象上使用 get() 方法

$address = $record->get('addr');

值的类型取决于 Neo4j 返回的内容，在我们的例子中，以下值将被返回

对于 addr 值返回 string
对于 n 值返回 Node
对于 ids 值返回 整数数组

这意味着

$record->get('addr'); // returns a string
$record->get('n'); // returns a Node object
$record->get('ids'); // returns an array

Node、Relationship 和 Path 对象都有进一步的方法，因此如果您知道通过标识符 n 返回的节点具有 countries 属性，您可以这样访问它

$addressNode = $record->get('n');
$countries = $addressNode->value('countries');

Record 对象包含三个用于 IDE 便捷性的方法，分别是

$record->nodeValue('n');
$record->relationshipValue('r');
$record->pathValue('p');

这并不提供额外的功能，只是 docblocks 为自动补全提示了 IDE。

额外：结果集合

当您使用 Stack 对象发送多个语句时，它将返回一个包含多个 Result 的 ResultCollection 对象。因此，在访问记录之前，您需要迭代结果。

处理事务

客户端提供了一个 Transaction 对象，它简化了您处理事务的方式。

创建事务

$tx = $client->transaction();

在此阶段，尚未向服务器发送任何内容（尚未发送 BEGIN 语句），这允许在提交之前堆叠查询或 Stack 对象。

堆叠查询

$tx->push('CREATE (n:Person) RETURN id(n)');

同样，到目前为止没有任何内容被发送。

在事务中运行查询

有时您想在事务内部立即获取语句的结果，这可以通过使用run方法来实现

$result = $tx->run('CREATE (n:Person) SET n.name = {name} RETURN id(n)', ['name' => 'Michal']);

echo $result->getRecord()->value("id(n)");

如果事务尚未开始，事务的BEGIN将自动完成。

您还可以推送或运行Stacks

$stack = $client->stack();
$stack->push('CREATE (n:Person {uuid: {uuid} })', ['uuid' => '123-fff']);
$stack->push('MATCH (n:Person {uuid: {uuid1} }), (n2:Person {uuid: {uuid2} }) MERGE (n)-[:FOLLOWS]->(n2)', ['uuid1' => '123-fff', 'uuid2' => '456-ddd']);

$tx->pushStack($stack);
// or
$results = $tx->runStack($stack);

提交和回滚

如果您在事务中（使用push方法添加）有排队语句，并且您已完成工作，您可以提交事务并接收结果

$stack = $client->stack();
$stack->push('CREATE (n:Person {uuid: {uuid} })', ['uuid' => '123-fff']);
$stack->push('MATCH (n:Person {uuid: {uuid1} }), (n2:Person {uuid: {uuid2} }) MERGE (n)-[:FOLLOWS]->(n2)', ['uuid1' => '123-fff', 'uuid2' => '456-ddd']);

$tx->pushStack($stack);
$tx->pushQuery('MATCH (n) RETURN count(n)');

$results = $tx->commit();

提交后，您将无法在此事务中push或run语句。

与多个连接一起工作

一般来说，您最好在集群环境中使用HAProxy运行Neo4j。然而，有时您可能希望完全控制将语句发送到哪个实例。

假设有一个包含3个neo4j节点的环境

$client = ClientBuilder::create()
    ->addConnection('node1', 'bolt://10.0.0.1')
    ->addConnection('node2', 'bolt://10.0.0.2')
    ->addConnection('node3', 'bolt://10.0.0.3')
    ->setMaster('node1')
    ->build();

默认情况下，$client->run()命令将把您的Cypher语句发送到列表中注册的第一个连接。

您可以通过指定别名作为run参数的第四个参数来指定将语句发送到哪个连接

$result = $client->run('CREATE (n) RETURN n', null, null, 'node1');

客户端也了解手动配置的主连接，因此您可以使用以下方式轻松发送写入操作

$client->runWrite('CREATE (n:User {login: 123})');

辅助方法

$client->getLabels();

返回一个Label对象的数组。

事件分发

在run方法期间会分发3种类型的事件

PreRunEvent：在语句或堆栈运行之前。
PostRunEvent：在语句或堆栈运行之后。
FailureEvent：在出现故障的情况下，您可以使用此事件禁用客户端抛出异常。

注册监听器

示例

$client = ClientBuilder::create()
    ->addConnection('default', 'bolt://')
    ->registerEventListener(Neo4jClientEvents::NEO4J_PRE_RUN, array($listener, 'onPreRun')
    ->build();

事件分发器可以通过客户端的$client->getEventDispatcher方法访问。

设置

超时（已弃用）

您可以为连接配置一个全局超时。

$client = ClientBuilder::create()
    ->addConnection('default', 'https://:7474')
    ->setDefaultTimeout(3)
    ->build();

默认超时为5秒。

此功能已弃用，将在版本5中删除。请参阅下面的HTTP客户端设置。

TLS

您可以通过在构建连接时传递一个Configuration实例来启用Bolt协议的TLS加密，以下是一个简单的示例

$config = \GraphAware\Bolt\Configuration::newInstance()
    ->withCredentials('bolttest', 'L7n7SfTSj')
    ->withTLSMode(\GraphAware\Bolt\Configuration::TLSMODE_REQUIRED);

$client = ClientBuilder::create()
    ->addConnection('default', 'bolt://hodccomjfkgdenl.dbs.gdb.com:24786', config)
    ->build();

HTTP客户端设置

我们使用HTTPlug为您提供对HTTP客户端的完全控制。Neo4jClient的版本4默认使用Guzzle6以保持向后兼容。版本5将为您提供选择任何客户端的选项。有关HTTPlug的更多信息，请参阅他们的文档。

要配置您的客户端，您可以将它添加到Configuration中。以下是一个使用php-http/curl-client的示例。

use Http\Client\Curl\Client;

$options = [
    CURLOPT_CONNECTTIMEOUT => 3, // The number of seconds to wait while trying to connect.
    CURLOPT_SSL_VERIFYPEER => false // Stop cURL from verifying the peer's certificate
];
$httpClient = new Client(null, null, $options);

$config = \GraphAware\Neo4j\Client\HttpDriver\Configuration::create($httpClient);
$client = ClientBuilder::create()
    ->addConnection('default', 'http://neo4j:password@localhost:7474', $config)
    ->build();

许可

该库根据MIT许可证发布，请参阅本包中包含的LICENSE文件。

imoox / neo4j-php-client

维护者

详细信息