This is a Gremlin server client for PHP. It allows you to run gremlin queries against graph databases (including Neo4j, Titan, etc.). You can find a beginner tutorial by reading the Get up and running with Tinkerpop 3 and PHP article.
This driver currently supports TP3+.
For a TP2 compatible php driver please check rexpro-php
Prefered method is through composer.
Either run :
php composer.phar require brightzone/gremlin-php "2.*"Or add:
"brightzone/gremlin-php": "2.*"to the require section of your composer.json file
BC breaking changes are introduced between major version changes. So if you're upgrading to 2.0.0 from 1.0. Please read the CHANGELOG
The Connection class exists within the rexpro namespace. (history: rexpro used to be the old protocol used by the driver in Tinkerpop2).
require_once('vendor/autoload.php');
use \Brightzone\GremlinDriver\Connection;
$db = new Connection;You can find more information by reading the API.
Here are a few basic usages.
Example 1 :
$db = new Connection([
'host' => 'localhost',
'graph' => 'graph'
]);
//you can set $db->timeout = 0.5; if you wish
$db->open();
$result = $db->send('g.V(2)');
//do something with result
$db->close();Note that "graph" is the name of the graph configured in gremlin-server (not the reference to the traversal which is g = graph.traversal())
Example 1 bis (With authentication) :
$db = new Connection([
'host' => 'localhost',
'graph' => 'graph',
'username' => 'pomme',
'password' => 'hardToCrack'
]);
//you can set $db->timeout = 0.5; if you wish
$db->open();
$db->send('g.V(2)');
//do something with result
$db->close();Example 2 (with bindings) :
$db = new Connection([
'host' => 'localhost',
'port' => 8182,
'graph' => 'graph',
]);
$db->open();
$db->message->bindValue('CUSTO_BINDING', 2);
$db->send('g.V(CUSTO_BINDING)'); //mix between Example 1 and 1B
//do something with result
$db->close();Example 3 (with session) :
$db = new Connection([
'host' => 'localhost',
'port' => 8182,
]);
$db->open();
$db->send('cal = 5+5', 'session');
$result = $db->send('cal', 'session'); // result = [10]
//do something with result
$db->close();Example 4 (transaction) :
$db = new Connection([
'host' => 'localhost',
'port' => 8182,
'graph' => 'graphT',
]);
$db->open();
$db->transactionStart();
$db->send('n.addVertex("name","michael")');
$db->send('n.addVertex("name","john")');
$db->transactionStop(FALSE); //rollback changes. Set to true to commit.
$db->close();Note that "graphT" above refers to a graph that supports transactions. And that transactions start a session automatically.
Example 4 bis (alternative transaction syntax) :
It is also possible to express transactions in the following manner:
$db = new Connection([
'host' => 'localhost',
'port' => 8182,
'graph' => 'graphT',
]);
$db->open();
$db->transaction(function(&$db){
$db->send('n.addVertex("name","michael")');
$db->send('n.addVertex("name","john")');
}, [&$db]);
$db->close();This will commit these changes or return an Exception if an error occured (and automatically rollback changes). The advantage of using this syntax is that it allows you to handle fail-retry scenarios as describbed in the next example.
Example 4 tres (transaction fail-retry) :
It is sometimes important to implement a fail-retry strategy for your transactional queries. One such example is in the event of concurrent writes to the same elements, the databases (such as titan) will throw an error. When this happens you will most likely want the driver to retry the query a few times until the element is unlocked and the write can proceed. For such instances you can do:
$db = new Connection([
'host' => 'localhost',
'port' => 8182,
'graph' => 'graphT',
'retryAttempts' => 10
]);
$db->open();
$db->transaction(function(&$db){
$db->send('n.addVertex("name","michael")');
$db->send('n.addVertex("name","john")');
}, [&$db]);
$db->close();This will attempt to run the query 10 times before fully failing.
It is worth noting that retryAttempts also works with out of session queries:
$db->send('gremlin.code.here'); // will retry multiple times if 'retryAttempts' is setExample 5 (Using message object) :
$message = new Message;
$message->gremlin = 'g.V()';
$message->op = 'eval';
$message->processor = '';
$message->setArguments([
'language' => 'gremlin-groovy',
// ... etc
]);
$message->registerSerializer('\Brightzone\GremlinDriver\Serializers\Json');
$db = new Connection();
$db->open();
$db->send($message);
//do something with result
$db->close();Of course you can affect the current db message in the same manner through $db->message.
Example 6 (SSL) :
$db = new Connection([
'host' => 'localhost',
'graph' => 'graph',
'ssl' => TRUE
]);
//you can set $db->timeout = 0.5; if you wish
$db->open();
$db->send('g.V(2)');
//do something with result
$db->close();Note that with php 5.6+ you will need to provide certificate information in the same manner you would to a stream_context_create(). In which case your Connection() call could look something like the following (replace with your own certificates and/or bundles):
$db = new Connection([
'host' => 'localhost',
'graph' => 'graph',
'ssl' => [
"ssl"=> [
"cafile" => "/path/to/bundle/ca-bundle.crt",
"verify_peer"=> true,
"verify_peer_name"=> true,
]
]
]);This library comes with a Json serializer. Any other serializer that implements SerializerInterface can be added dynamically with:
$db = new Connection;
$serializer = $db->message->getSerializer() ; // returns an instance of the default JSON serializer
echo $serializer->getName(); // JSON
echo $serializer->getMimeType(); // application/json
$db->message->registerSerializer('namespace\to\my\CustomSerializer', TRUE); // sets this as default
$serializer = $db->message->getSerializer(); // returns an instance the CustomSerializer serializer (default)
$serializer = $db->message->getSerializer('application/json'); // returns an instance the JSON serializerYou can add many serializers in this fashion. When gremlin-server responds to your requests, gremlin-client-php will be capable of using the appropriate one to unserialize the message.
You can find the api here.
Neo4J is required for the full test suit. It is not bundled with gremlin-server by default so you will need to manually install it with:
bin/gremlin-server.sh -i org.apache.tinkerpop neo4j-gremlin 3.0.2-incubatingCopy the following files :
cp <gremlin-php-root-dir>/build/server/gremlin-server-php.yaml <gremlin-server-root-dir>/conf/
cp <gremlin-php-root-dir>/build/server/neo4j-empty.properties <gremlin-server-root-dir>/conf/
cp <gremlin-php-root-dir>/build/server/gremlin-php-script.groovy <gremlin-server-root-dir>/scripts/You will then need to run gremlin-server in the following manner :
bin/gremlin-server.sh conf/gremlin-server-php.yamlThen run the unit test via:
phpunit -c build/phpunit.xml
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent