- Notifications
You must be signed in to change notification settings - Fork93
PHP Client for Neo4j with Enterprise Support
License
graphaware/neo4j-php-client
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Neo4j-PHP-Client is the most advanced and flexibleNeo4j Client for PHP.
Neo4j is a transactional, open-source graph database. A graph database manages data in a connected data structure, capable of representing any kind of data in a very accessible way. Information is stored in nodes and relationships connecting them, both of which can have arbitrary properties. To learn more visitWhat is a Graph Database?
- Supports multiple connections
- Support for Bolt binary protocol
- Built-in and automatic support forNeo4j Enterprise HA Master-Slave Mode with auto slaves fallback
| Version | Tested |
|---|---|
| <= 2.2.6 | No |
| >= 2.2.6 | Yes |
| 2.2 | Yes |
| 2.3 | Yes |
| Feature | Supported? |
|---|---|
| Auth | Yes |
| Remote Cypher | Yes |
| Transactions | Yes |
| High Availability | Yes |
| Embedded JVM support | No |
| Binary Protocol | Yes |
- PHP >= 5.6, < 8.0
- A Neo4j database (minimum version 2.2.6)
You can:
- Check out anexample application built with NeoClient
- Ask a question on StackOverflow
- For bugs, please feel free to create anew issue on GitHub
Add the library to your composer dependencies :
omposer require graphaware/neo4j-php-client:^4.0@alpha
Require the composer autoloader, configure your connection by providing a connection alias and your connection settings :
<?phprequire_once'vendor/autoload.php';useGraphAware\Neo4j\Client\ClientBuilder;$client = ClientBuilder::create() ->addConnection('default','http://neo4j:password@localhost:7474') ->build();
You're now ready to connect to your database.
NB: The build method will process configuration settings and return you aClient instance.
$client->run("CREATE (n:Person)");
$client->run("CREATE (n:Person) SET n += {infos}", ['infos' => ['name' =>'Ales','age' =>34]]);
$result =$client->run("MATCH (n:Person) RETURN n";// a result contains always 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();
ARecord object contains the values of one record from your Cypher query :
$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'));}
Ideally, you would stack your statements and issue them all at once in order to improve performance.
You can create Cypher statement stacks that act as a Bag and run this stack with the client, example :
$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);
Sometimes, you may want to retrieve a specific result from a Stack, an easy way to do this is to tag your Cypher statements.
The tag is passed via the 3rd argument of therun orpush methods :
$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');
Therun method returns you a singleResult object. Other methods where you can expect multiple results returns aResultCollection object which is Traversable.
TheResult object contains therecords and thesummary of the statement, the following methods are available in the API :
$result->getRecord();// Returns one record$result->records();// Returns all records$result->summarize();// Returns the ResultSummary
TheResultSummary contains theStatement, the Statistics and the QueryPlan if available :
$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();
Each record contains one row of values returned by the Cypher query :
$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->value('n'); // nodes returned are automatically hydrated to Node objects echo $record->value('name') . PHP_EOL; echo $record->value('age') . PHP_EOL;}The client takes care of the hydration of Graph objects to PHP Objects, so it is for Node, Relationship and Path :
labels(): returns an array of labels (string)identity(): returns the internal ID of the nodevalues(): returns the properties of the node (array)value($key): returns the value for the given property keyhasLabel($label): returns whether or not the node has the given label (boolean)startNodeIdentity: returns the start node idendNodeIdentity: returns the end node id
type(): returns the relationship typeidentity(): returns the internal ID of the relationshipvalues(): returns the properties of the relationship (array)value($key): returns the value for the given property key
The Client provides a Transaction object that ease how you would work with transactions.
$tx =$client->transaction();
At this stage, nothing has been sent to the server yet (the statement BEGIN has not been sent), this permits to stack queries or Stack objects before commiting them.
$tx->push("CREATE (n:Person) RETURN id(n)");Again, until now nothing has been sent.
Sometimes you want to get an immediate result of a statement inside the transaction, this can be done with therun method :
$result =$tx->run("CREATE (n:Person) SET n.name = {name} RETURN id(n)", ['name' =>'Michal']);echo$result->getRecord()->value("id(n)");
If the transaction has not yet begun, the BEGIN of the transaction will be done automatically.
#### You can also push or run Stacks```php$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);if you have queued statements in your transaction (those added with thepush methods) and you have finish your job, you can commit the transaction and receivethe results :
$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();
After a commit, you will not be able topush orrun statements in this transaction.
The library is released under the MIT License, refer to the LICENSE file.
About
PHP Client for Neo4j with Enterprise Support
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Languages
- PHP99.2%
- Other0.8%