laudis/graphaware-neo4j-php-client-legacy

Neo4j PHP旧版客户端是Graphaware Neo4j PHP客户端的分支

维护者

详细信息

github.com/transistive/neo4j-php-client

主页

源代码

安装: 32

依赖: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 138

5.0.1 2021-05-27 13:12 UTC

Requires

Requires (Dev)

MIT 17328c7e4da40f283d87d1054c20a225b30e1bb8

  • Ghlen Nagels <ghlen.woop@pm.me>

databasehttpclientgraphneo4jclusterbolthigh-availability

This package is auto-updated.

Last update: 2024-08-29 05:31:35 UTC

README

⚠️ 警告 ⚠️

这是一个旧版API。该项目存在是为了允许人们在现有项目中快速使用neo4j的新版本。对于最新驱动程序和最新功能，请访问neo4j php client，该链接位于neo4j-php github页面上。

主要功能

  • 支持多连接
  • 支持Bolt二进制协议
  • 内置和自动支持Neo4j企业版主从模式，带有自动从节点回退

Neo4j版本支持

Neo4j功能支持

要求

  • PHP >= 7.0
  • ext-bcmath
  • ext-mbstring
  • Neo4j数据库（最低版本2.2.6）

获取帮助

您可以

实现

安装和基本用法

安装

将库添加到您的composer依赖项

composer require "laudis/graphaware-neo4j-php-client-legacy"

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

现在您可以连接到您的数据库了。

NB:构建方法将处理配置设置并返回一个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）

关于此主题有三个主要概念

  1. 结果
  2. 记录
  3. 记录值

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

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

screen shot 2016-05-11 at 20 54 34bis

结果

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);
}
记录值

每个记录都包含一个 Record Value 的集合，这些值通过一个 key 来标识，该键是在 Cypher 查询的 RETURN 子句中给出的标识符。在我们的例子中，一个 Record 将包含以下键

  • addr
  • n
  • ids

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

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

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

  • addr 值为 string
  • n 值为 Node
  • ids 值为 整数 的 array

这意味着

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

如果节点 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。

您还可以推送或运行 Stack

$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 语句发送到列表中注册的第一个连接。

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

$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://localhost')
    ->registerEventListener(Neo4jClientEvents::NEO4J_PRE_RUN, array($listener, 'onPreRun')
    ->build();

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

设置

超时（已弃用）

您可以配置连接的全局超时。

$client = ClientBuilder::create()
    ->addConnection('default', 'http://localhost: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 文件。