longitude-one/neo4j-php-client

Neo4j-PHP-Client 是最先进的 Neo4j PHP 客户端

维护者

详细信息

github.com/longitude-one/neo4j-php-client

源代码

问题

安装: 283

依赖项: 1

建议者: 0

安全: 0

星级: 2

关注者: 4

分支: 1

开放问题: 1

1.0.1 2020-07-02 12:09 UTC

Requires

Requires (Dev)

MIT d78c5f211b10f3c3609bd08e653fdd5c0cbc0e69

  • Christophe Willemsen <christophe.woop@graphaware.com>

databasehttpclientgraphneo4jclusterbolthigh-availability

This package is auto-updated.

Last update: 2024-08-29 05:43:20 UTC

README

此 Neo4j PHP 客户端是 GraphAware Neo4j PHP 客户端的一个分支。由于此包自 2017 年以来未得到维护，并被存档到一个只读仓库，LongitudeOne 决定将其分支出来，并创建一个真正全新的包。简单的分支是一个问题，因为问题和拉取请求仍然集中在上 graphaware/neo4j-php-client。

Build Status Version Total Downloads License

介绍

最初由 GraphAware 创建，Neo4j-PHP-Client 是最先进且灵活的 Neo4j PHP 客户端。现在由 LongitudeOne 维护此项目。

什么是 Neo4j？

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

主要功能

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

Neo4j 版本支持

此项目 不能 与版本 4.0+ 一起使用。

Neo4j 功能支持

要求

由于 PHP7.2 及以下版本不再维护，neo4j-php-client 现在只与 PHP7.3+ 进行测试。

  • PHP >= 7.3
  • ext-bcmath
  • ext-json
  • ext-mbstring
  • Neo4j 数据库（最小版本 3.0，最大版本 4.0 除外）

获取帮助

要获取帮助，您应该

实现

安装和基本用法

安装

将库添加到您的 composer 依赖项

composer require "longitude-one/neo4j-php-client:^1.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、统计信息和可选的 QueryPlan

$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;
}

客户端负责将Graph对象转换为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

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 为自动完成提供了提示。

附加：结果集合

当你使用 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 = $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 许可证发布，请参阅此包附带的有效许可证文件。