apache tinkerpop logo

3.3.0-SNAPSHOT

TinkerPop Compendium

tinkerpop reading

The primary documentation for Apache TinkerPop is the Reference Documentation, which provides the most complete guide to TinkerPop usage. All other documentation tends to exist in support of that reference guide. Other documentation tends to fall into one of these other categories:

  1. Tutorials - Brief but detailed explanations of specific technologies, patterns, use cases or best practices related to TinkerPop.

  2. Publications - Blog posts, technical papers, presentation materials, etc.

  3. Developer - Documentation for contributors to TinkerPop or for providers (i.e. those who implement TinkerPop’s interfaces).

Note
Some of the documentation listed here leads to third-party web sites. Such documentation is supplemental to Apache TinkerPop. Third-party documentation is marked as such in the listings below.

Tutorials

gremlin-gym-cropped

Getting Started with TinkerPop
A gentle introduction to TinkerPop and the Gremlin traversal language that is divided into five, ten and fifteen minute tutorial blocks.

gremlin-dashboard

The Gremlin Console
Provides a detailed look at The Gremlin Console and how it can be used when working with TinkerPop.

gremlin-chef

Gremlin Recipes A collection of best practices and common traversal patterns for Gremlin.

gremlin-house-of-mirrors-cropped

Gremlin Language Variants Instructs developers on the approach to building a Gremlin variant in their native programming language.

gremlin-lab-coat

Sql2Gremlin
Learn Gremlin using typical patterns found when querying data with SQL. (external)

gremlin-standing

Getting Started with Graph Databases
A brief overview of RDBMS architecture in comparison to graph, basic graph terminology, a real-world use case for graph, and an overview of Gremlin. (external)

Publications

Unless otherwise noted, all "publications" are externally managed:

Developer

business-gremlin

Contributors
Provides information on ways to contribute to TinkerPop as well as details on building the project and other specific information for contributors.

tinkerpop-enabled

Providers
Documentation for providers who implement the TinkerPop interfaces, develop plugins or drivers, or provide other third-party libraries for TinkerPop.

gremlin-io2

IO Reference
Reference Documentation for providers and users of the various IO formats that TinkerPop has: GraphML, GraphSON and Gryo.