JarCastingCypher for Gremlin
Cypher for Gremlin is a toolkit for users of Apache TinkerPop™ that allows querying Gremlin databases with Cypher, the industry's most widely used property graph query language defined and maintained by the openCypher project.
Cypher query is translated to one of Gremlin representations (Gremlin Groovy string, Traversal object or Gremlin bytecode):
Table of Contents
- Overview
- Highlights
- Quick Start
- Toolkit
- Language Support
- Related
- Implementation
- Development
- How to contribute
- License
- Copyright
Overview
Highlights
Gremlin Console Plugin
Gremlin Console plugin that enables client-side translation of Cypher queries or communication with a Cypher-enabled Gremlin Server (click to play/view source):
Gremlin Server Client
Gremlin Server client wrapper that can send Cypher queries to a Cypher-enabled Gremlin Server or translate Cypher queries to Gremlin on client side, and send translated query to servers:
String cypher = "MATCH (p:person) WHERE p.age > 25 RETURN p.name";
Cluster cluster = Cluster.open(configuration);
Client gremlinClient = cluster.connect();
// Server has Gremlin Server plugin installed
// Send Cypher to server
CypherGremlinClient cypherGremlinClient = CypherGremlinClient.plugin(gremlinClient);
List<Map<String, Object>> cypherResults = cypherGremlinClient.submit(cypher).all();
// Client side translation
// Send Gremlin to server
CypherGremlinClient translatingGremlinClient = CypherGremlinClient.translating(gremlinClient);
List<Map<String, Object>> gremlinResults = translatingGremlinClient.submit(cypher).all();
assertThat(cypherResults).isEqualTo(gremlinResults);
Gremlin Neo4j Driver
Implementation of Neo4j API interfaces for users familiar with Neo4j:
Driver driver = GremlinDatabase.driver(uri);
try (Session session = driver.session()) {
StatementResult result = session.run("MATCH (n) RETURN count(n) as count");
int n = result.single().get("count").asInt();
assertThat(n).isEqualTo(0); // 0
}
Gremlin Server Plugin
Gremlin Server plugin that enables Cypher query processing on Gremlin Server. For example connect using Gremlin-JavaScript 3.4.2+ by setting processor to cypher:
// npm install [email protected]
const gremlin = require('gremlin');
const client = new gremlin.driver.Client('ws://localhost:8182/gremlin', { traversalSource: 'g', processor: 'cypher'});
const cypherQuery = 'MATCH (n) RETURN n.name'
const results = await client.submit(cypherQuery);
for (const result of results) {
console.log(result);
}
See examples for Gremlin-Java, Gremlin-Groovy, Gremlin-Python and Gremlin.Net
Cypher Traversal Source
For Gremlin Console Plugin and Gremlin Server Client its possible to combine Cypher and Gremlin in single query. Traversal can start with cypher step that allows to run Cypher query (which will be translated to Gremlin and works withRemote) then continue traversal using other Gremlin steps:
CypherTraversalSource g = graph.traversal(CypherTraversalSource.class);
GraphTraversal<Map<String, Object>, String> query = g
.cypher("MATCH (n) RETURN n")
.select("n")
.outE()
.label()
.dedup();
Quick Start
- Run Docker images
- Start experimenting with Cypher for Gremlin with the Gremlin Console Cypher plugin. Follow the link for installation and usage instructions.
- For API usage take a look at the Cypher for Gremlin Demo project.
Toolkit
The toolkit is composed of:
- translation: Cypher to Gremlin translation library for Java
- tinkerpop/cypher-gremlin-extensions: Extensions to Gremlin to enable full support for Cypher functionality
- tinkerpop/cypher-gremlin-server-plugin: Gremlin Server plugin that enables Cypher query processing (also includes extensions above)
- tinkerpop/cypher-gremlin-console-plugin: Gremlin Console plugin that enables client-side translation of Cypher queries or communication with a Cypher-enabled Gremlin Server
- tinkerpop/cypher-gremlin-server-client: Gremlin Server client wrapper that can send Cypher queries to a Cypher-enabled Gremlin Server
- tinkerpop/cypher-gremlin-neo4j-driver: Neo4j Java API wrapper for users familiar with Neo4j
Language Support
With Cypher for Gremlin you can use the following Cypher language features:
MATCHandOPTIONAL MATCHWHERE,ORDER BY,SKIP, andLIMITsub-clausesRETURN,WITH, andUNWINDprojections, including basic support for list and path comprehensionsCREATE,MERGE,SET,REMOVE, and(DETACH) DELETECASEexpressionsUNION (ALL)operationsCALLprocedures
It is not guaranteed that all instances and combinations of the listed features will work. However, in addition to integration tests, correctness of translation is verified by the Cypher Technology Compatibility Kit (TCK). The TCK is an openCypher artifact and contains a comprehensive set of test scenarios validating different features of the Cypher language.
Coverage of TCK M13 (excluding Temporal Types) on TinkerGraph:
- 75% of the scenarios are supported with common Gremlin steps
- Additional 15% with extensions to Gremlin to enable full support for Cypher functionality
- See latest TCK Report for a detailed overview of language coverage.
You are very welcome to report any issues with the translation that you encounter.
Gremlin Implementations
Cypher for Gremlin is tested on following Gremlin implementations:
- With Gremlin Extensions for Cypher Support
- Without extensions
- TinkerGraph
- Neptune with
neptuneflavor - CosmosDB with
cosmosDbflavor
Each Gremlin implementation has its own level of Gremlin support and Gremlin step implementation specifics. In some cases, queries need to be adapted for target implementation using flavor.
Because of these specifics, Cypher support varies on different implementations. Refer to wiki for more details.
Related
- Gizmo is a Web UI that makes it easy to interact with TinkerPop graph databases such as AWS Neptune and Azure CosmosDB with the Cypher query language. Uses Cypher Gremlin Neo4j Driver for translation.
- Graph Database support plugin for JetBrains allows you to work with Tinkerpop and Neo4j databases using Cypher without leaving IDE. Uses Cypher for Gremlin for translation.
Implementation
The translation process uses a reasonably sophisticated and flexible approach. Cypher query is parsed by the openCypher Frontend and translated to an internal representation by the Cypher for Gremlin. The internal representation is transformed by a set of rewriters to adapt the query for system specifics of different Gremlin implementations (JanusGraph, Cosmos DB, AWS Neptune), then converted to one of Gremlin representations (Gremlin Groovy string, Traversal object or Gremlin bytecode).
See also How to implement new Cypher feature?
Development
To build and run Cypher for Gremlin you need Java 8. The project is built using Gradle or the provided wrapper.
To build and run unit and integration tests:
./gradlew build
To automatically fix formatting errors in your changes:
./gradlew spotlessApply
How to contribute
We would love to find out about any issues you encounter and are happy to accept contributions following a Contributors License Agreement (CLA) signature as per the process outlined in our contribution guidelines.
License
The project is licensed under the Apache Software License, Version 2.0
Copyright
© Copyright 2018-2019 Neo4j, Inc.
Apache TinkerPop™, TinkerPop, and Apache are registered trademarks of the Apache Software Foundation.
