gql-gremlin

gql-gremlin is an optional Apache TinkerPop module that provides TinkerGQL, a deliberate minimal subset of ISO GQL MATCH syntax, as a portable graph-pattern execution engine for the match(String) step.

Any TinkerPop graph provider can add TinkerGQL support to their graph and provide deeper optimizations than those provided by TinkerPop's default implementation. TinkerGraph ships with the default out of the box.

What is TinkerGQL?

TinkerGQL is the named dialect implemented by gql-gremlin. It covers enough of the GQL MATCH grammar to express multi-hop path patterns, inline property filters, parameterized queries, and multi-pattern joins.

Full syntax reference: the-traversal.asciidoc TinkerGQL.

Quick start (using TinkerGraph)

TinkerGraph registers TinkerGQL automatically. No configuration is needed:

graph = TinkerFactory.createModern()
g = graph.traversal()

g.match("MATCH (a:person)-[:knows]->(b:person)").
  select("a", "b").by("name")
// ==>[a:marko, b:vadas]
// ==>[a:marko, b:josh]
// ...

Maven dependency

<dependency>
    <groupId>org.apache.tinkerpop</groupId>
    <artifactId>gql-gremlin</artifactId>
    <version>x.y.z</version>
</dependency>