Home

Attention: this Wiki hosts an outdated version of the TinkerPop framework and Gremlin language documentation.

Please visit the Apache TinkerPop website and latest documentation.

---

Gremlin is a graph traversal language. The documentation herein will provide all the information necessary to understand how to use Gremlin for graph query, analysis, and manipulation. Gremlin works over those graph databases/frameworks that implement the Blueprints property graph data model. Gremlin is a style of graph traversal that can be used in various JVM languages. This distribution of Gremlin provides support for Java and Groovy. Except where otherwise stated, the documentation herein is respective of the Groovy implementation (minor syntactic tweaks are required to map the ideas over to other JVM implementations).

Please join the Gremlin users group at http://groups.google.com/group/gremlin-users for all TinkerPop related discussions. ¹

// calculate basic collaborative filtering for vertex 1
m = [:]
g.v(1).out('likes').in('likes').out('likes').groupCount(m)
m.sort{-it.value}

// calculate the primary eigenvector (eigenvector centrality) of a graph
m = [:]; c = 0;
g.V.as('x').out.groupCount(m).loop('x'){c++ < 1000}
m.sort{-it.value}

• GremlinDocs (easy reference manual)
• SQL2Gremlin (easy reference manual)

---

• The Benefits of Gremlin
• Basic Concepts
  • Getting Started
  • Learning Dependencies
  • Defining a Property Graph
  • Basic Graph Traversals
  • Gremlin API
    • Gremlin Steps (cheat sheet)
      • GremlinPipeline JavaDoc (definitive)
    • Gremlin Methods (cheat sheet)
      • Updating a Graph
• Intermediate Concepts
  • Defining a More Complex Property Graph
  • Traversal Patterns
    • Backtrack Pattern
    • Except/Retain Pattern
    • Flow Rank Pattern
    • Path Pattern
    • Loop Pattern
    • Split/Merge Pattern
    • MapReduce Pattern
    • Pattern Match Pattern
    • Tree Pattern
  • Step Closures
  • User Defined Steps
  • Depth-First vs. Breadth-First
  • Traversal Optimization
  • Writing Gremlin REPL Plugins
• Graph Framework Connectors
  • Using JUNG
  • SPARQL vs. Gremlin
  • LinkedData Sail (Traversing the Web of Data)
• JVM Language Implementations (cheat sheet)
  • Gremlin Java
    • Using Gremlin through Java
  • Gremlin Groovy
    • Using Gremlin through Groovy
    • Gremlin Groovy Path Optimizations
  • Gremlin Scala (third-party)
  • Gremlin Clojure (third-party)
  • Gremlin Clojure (Ogre) (third-party)
  • Gremlin JavaScript (third-party)
  • Gremlin JRuby (Pacer) (third-party)
  • Gremlin Python (third-party)
• Conclusion
  • Troubleshooting
  • Acknowledgments
  • Release Notes

The Graph Traversal Programming Pattern (Presentation of Basic Graph Traversal Concepts)
On the Nature of Pipes (Understand the Gremlin Engine)
Gremlin Tutorial 1 (Screencast of Gremlin 0.7)
Gremlin Tutorial 2 (Presentation of Gremlin 1.1)

---

<!-- * can be java, groovy, or test -->
<dependency>
   <groupId>com.tinkerpop.gremlin</groupId>
   <artifactId>gremlin-*</artifactId>
   <version>2.6.0</version>
</dependency>

Non-Maven users can get the raw release jars from Apache’s Central Repository. Snapshots can be obtained from Sonatype (see Maven Repositories for more information).

¹ Gremlin documentation is up to date with the current Gremlin codebase, not with the latest Gremlin release.

Gremlin JavaDoc: 2.6.0 – 2.5.0 – 2.4.0 – 2.3.0 – 2.2.0 – 2.1.0 – 2.0.0
Gremlin WikiDoc: 2.6.0 – 2.5.0 – 2.4.0 – 2.3.0 – 2.2.0 – 2.1.0 – 2.0.0