Apache TinkerPop

https://tinkerpop.apache.org/docs
Admin
Apache TinkerPop is a graph computing framework that provides a graph traversal language (Gremlin)...
Tokens:5,595,576
Snippets:42,965
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Windows Build Setup: Hadoop Binaries

Source: https://tinkerpop.apache.org/docs/3.6.4/dev/developer

Instructions for setting up Hadoop winutils binaries on Windows. Requires downloading winutils.exe and hadoop.dll, placing them in a specific directory structure, and setting HADOOP_HOME and PATH environment variables.

```bash
# Example directory structure:
hadoop-3.3.1/bin/winutils.exe

# Set environment variables:
HADOOP_HOME=C:\path\to\hadoop-3.3.1
PATH=%HADOOP_HOME%\bin;%PATH%
```

--------------------------------

### Install Gremlin.Net C# Template

Source: https://tinkerpop.apache.org/docs/3.4.9/reference

Provides the dotnet CLI commands to install the Gremlin.Net template for creating new C# console projects that connect to Gremlin Server. This facilitates getting started with Gremlin.Net.

```bash
dotnet new -i Gremlin.Net.Template
```

```bash
dotnet new gremlin
```

```bash
dotnet new gremlin -o MyFirstGremlinProject
```

--------------------------------

### Setup SparkGraphComputer for OLAP Gremlin Operations

Source: https://tinkerpop.apache.org/docs/3.4.9/reference

This snippet shows the steps to set up and use SparkGraphComputer for OLAP operations with Gremlin. It involves starting the Gremlin shell, installing the Spark Gremlin plugin, and activating the Spark plugin. This enables distributed graph computations leveraging Apache Spark.

```bash
$ bin/gremlin.sh

         \,,,/
         (o o)
-----oOOo-(3)-oOOo-----
plugin activated: tinkerpop.server
plugin activated: tinkerpop.utilities
plugin activated: tinkerpop.tinkergraph
plugin activated: tinkerpop.hadoop
gremlin> :install org.apache.tinkerpop spark-gremlin 3.4.9
==>loaded: [org.apache.tinkerpop, spark-gremlin, 3.4.9] - restart the console to use [tinkerpop.spark]
gremlin> :q
$ bin/gremlin.sh

         \,,,/
         (o o)
-----oOOo-(3)-oOOo-----
plugin activated: tinkerpop.server
plugin activated: tinkerpop.utilities
plugin activated: tinkerpop.tinkergraph
plugin activated: tinkerpop.hadoop
gremlin> :plugin use tinkerpop.spark
==>tinkerpop.spark activated
```

--------------------------------

### Hadoop-Gremlin OLTP Setup and Traversal Examples

Source: https://tinkerpop.apache.org/docs/3.0

Demonstrates setting up a HadoopGraph for OLTP operations and executing basic Gremlin traversals. This includes copying data to HDFS, listing HDFS files, opening a graph using a properties file, and performing count, out-neighbor, and grouping traversals. Note that OLTP on HadoopGraph is inefficient due to linear scans.

```gremlin
hdfs.copyFromLocal('data/tinkerpop-modern.kryo', 'tinkerpop-modern.kryo')

```

```gremlin
hdfs.ls()

```

```gremlin
graph = GraphFactory.open('conf/hadoop/hadoop-gryo.properties')

```

```gremlin
g = graph.traversal()

```

```gremlin
g.V().count()

```

```gremlin
g.V().out().out().values('name')

```

```gremlin
g.V().group().by{it.value('name')[1]}.by('name').next()

```

--------------------------------

### PartitionStrategy Example in Gremlin

Source: https://tinkerpop.apache.org/docs/3.1.2-SNAPSHOT/reference

Demonstrates how to create and use PartitionStrategy to partition graph elements into different sets. It shows how to define partition keys, write partitions, and read partitions, and how these affect element creation and traversal.

```gremlin
graph = TinkerFactory.createModern()
strategyA = PartitionStrategy.build().partitionKey("_partition").writePartition("a").addReadPartition("a").create()
strategyB = PartitionStrategy.build().partitionKey("_partition").writePartition("b").addReadPartition("b").create()
gA = GraphTraversalSource.build().with(strategyA).create(graph)
gA.addV() // this vertex has a property of {_partition:"a"}
gB = GraphTraversalSource.build().with(strategyB).create(graph)
gB.addV() // this vertex has a property of {_partition:"b"}
gA.V()
gB.V()
```

--------------------------------

### SimpleAuthenticator Quick Start

Source: https://tinkerpop.apache.org/docs/3.1.1-incubating/reference

A quick start guide for enabling the `SimpleAuthenticator` using TinkerGraph for credentials and the provided sample credential graph.

```APIDOC
## SimpleAuthenticator Quick Start

### Description
This guide demonstrates a quick way to set up and start Gremlin Server with the `SimpleAuthenticator` using the bundled TinkerGraph for storing credentials.

### Method
Command line execution and configuration file usage.

### Endpoint
N/A

### Parameters
N/A

### Request Example
1. **Start Gremlin Server with a secure configuration file:**
   ```bash
   $ bin/gremlin-server.sh conf/gremlin-server-secure.yaml
   ```
   This command starts the server with SSL enabled and configured to use the `SimpleAuthenticator` with TinkerGraph credentials.

### Response
Server startup logs indicating successful configuration and initialization of SSL and the `SimpleAuthenticator`.

#### Success Response (200)
N/A

#### Response Example
```
[INFO] GremlinServer - Configuring Gremlin Server from conf/gremlin-server-secure.yaml
...
[WARN] AbstractChannelizer - Enabling SSL with self-signed certificate (NOT SUITABLE FOR PRODUCTION)
[INFO] AbstractChannelizer - SSL enabled
[INFO] SimpleAuthenticator - Initializing authentication with the org.apache.tinkerpop.gremlin.server.auth.SimpleAuthenticator
[INFO] SimpleAuthenticator - CredentialGraph initialized at CredentialGraph{graph=tinkergraph[vertices:1 edges:0]}
...
[INFO] GremlinServer$1 - Channel started at port 8182.
```
```

--------------------------------

### Windows Build Setup: Hadoop Binaries

Source: https://tinkerpop.apache.org/docs/3.7.4-SNAPSHOT/dev/developer

Instructions for setting up `winutils.exe` and `hadoop.dll` for building TinkerPop on Windows. These are required for Hadoop compatibility.

```bash
# Example directory structure:
hadoop-3.3.1/bin/winutils.exe
# Set HADOOP_HOME environment variable to point to the hadoop-3.3.1 folder
# Add %HADOOP_HOME%\bin to your system PATH
```

--------------------------------

### Install and Use Gremlin-Go

Source: https://tinkerpop.apache.org/docs/3.7.1/upgrade

Provides instructions and a code example for installing and using the Gremlin-Go driver. Requires Golang 1.20+ and Go Modules. The example demonstrates connecting to a Gremlin server, performing a simple traversal, and handling results.

```Go
go get github.com/apache/tinkerpop/gremlin-go/v3@v3.5.4

package main

import (
    "fmt"
    "github.com/apache/tinkerpop/gremlin-go/v3/driver"
)

func main() {
    // Creating the connection to the server
    driverRemoteConnection, err := gremlingo.NewDriverRemoteConnection("ws://localhost:8182/gremlin",
        func(settings *gremlingo.DriverRemoteConnectionSettings) {
            // Configure optional settings
            settings.LogVerbosity = gremlingo.Info
            settings.InitialConcurrentConnections = 2
        }
    )
    // Handle error
    if err != nil {
        fmt.Println(err)
        return
    }
    // Cleanup
    defer driverRemoteConnection.Close()

    // Creating graph traversal
    g := gremlingo.Traversal_().WithRemote(driverRemoteConnection)

    // Perform traversal
    result, err := g.V().Count().ToList()
    if err != nil {
    fmt.Println(err)
        return
    }
    fmt.Println(result[0].GetString())
}
```

--------------------------------

### Group adjacent vertices by label and collect them

Source: https://tinkerpop.apache.org/docs/3.4.13-SNAPSHOT/recipes

This traversal starts from a vertex, traverses to its adjacent vertices, groups them by their labels, and then collects these groups. The first example selects the starting vertex and the grouped adjacent vertices. The second example performs a more complex grouping, first by the starting vertex, then by the label of adjacent vertices, and finally collects all adjacent vertices for each label.

```groovy
g.V(1).as("a").
           both().
           map(group().by(label).by(unfold())).as("b").
           select("a","b").
           map(union(project("a").by(select("a")), select("b")).
           unfold().
           group().
             by(select(keys)).
             by(select(values)))
```

```groovy
g.V().as("a").
           both().
           map(group().by(label).by(unfold())).as("b").
           select("a","b").
           group().
             by("a").
             by(select("b").
                  group().
                    by(select(keys)).
                    by(select(values).fold())).
             unfold().
             map(union(select(keys).project("a").by(), select(values)).
             unfold().
             group().
               by(select(keys).unfold()).
               by(select(values).unfold().unfold().fold()))
```

```groovy
g.V(1).as("a").
  both().
  map(group().by(label).by(unfold())).as("b").
  select("a","b").
  map(union(project("a").by(select("a")), select("b")).
  unfold().
  group().
    by(select(keys)).
    by(select(values)))
```

```groovy
g.V().as("a").
  both().
  map(group().by(label).by(unfold())).as("b").
  select("a","b").
  group().
    by("a").
    by(select("b").
         group().
           by(select(keys)).
           by(select(values).fold())).
    unfold().
    map(union(select(keys).project("a").by(), select(values)).
    unfold().
    group().
      by(select(keys).unfold()).
      by(select(values).unfold().unfold().fold()))
```

--------------------------------

### Windows Build Setup for TinkerPop

Source: https://tinkerpop.apache.org/docs/3.6.6-SNAPSHOT/dev/developer

Instructions for setting up the build environment on Windows, including installing winutils, setting environment variables, and running the Maven build.

```bash
set HADOOP_HOME=C:\path\to\hadoop-3.3.1
set PATH=%HADOOP_HOME%\bin;%PATH%
mvn clean install
```

--------------------------------

### Build and Install Project

Source: https://tinkerpop.apache.org/docs/3.6.2-SNAPSHOT/dev/developer

Commands to clean the project, install artifacts, and build Docker images. This is a foundational step for preparing a release.

```bash
mvn clean install
docker/build.sh -t -i -n
```

--------------------------------

### Install and Use Gremlin-Go

Source: https://tinkerpop.apache.org/docs/3.6.5-SNAPSHOT/upgrade

Provides instructions and a code example for installing and using the Gremlin-Go driver. Requires Go 1.20+ and Go Modules.

```Bash
go get github.com/apache/tinkerpop/gremlin-go/v3@v3.5.4
```

```Go
package main

import (
    "fmt"
    "github.com/apache/tinkerpop/gremlin-go/v3/driver"
)

func main() {
    // Creating the connection to the server
    driverRemoteConnection, err := gremlingo.NewDriverRemoteConnection("ws://localhost:8182/gremlin",
        func(settings *gremlingo.DriverRemoteConnectionSettings) {
            // Configure optional settings
            settings.LogVerbosity = gremlingo.Info
            settings.InitialConcurrentConnections = 2
        }
    )
    // Handle error
    if err != nil {
        fmt.Println(err)
        return
    }
    // Cleanup
    defer driverRemoteConnection.Close()

    // Creating graph traversal
    g := gremlingo.Traversal_().WithRemote(driverRemoteConnection)

    // Perform traversal
    result, err := g.V().Count().ToList()
    if err != nil {
    fmt.Println(err)
        return
    }
    fmt.Println(result[0].GetString())
}
```

--------------------------------

### Find Vertex by Property (Gremlin)

Source: https://tinkerpop.apache.org/docs/3.4.13/recipes

These Gremlin queries demonstrate how to find specific vertices in the graph based on their properties. For example, `g.V().has("job", "name", "job1").next()` retrieves the vertex representing 'job1'. These are often used to get starting points for more complex traversals.

```gremlin
vBlueprintsJob1 = g.V().has("job", "name", "job1").next()
```

```gremlin
vRexsterJob1 = g.V().has("job", "name", "job4").next()
```

```gremlin
vStephen = g.V().has("person", "name", "stephen").next()
```

```gremlin
vBob = g.V().has("person", "name", "bob").next()
```

--------------------------------

### Setup Winutils for Hadoop on Windows

Source: https://tinkerpop.apache.org/docs/3.7.2/dev/developer

Instructions for setting up Hadoop winutils on Windows, which are required for certain Hadoop-related functionalities. This involves downloading binaries, setting environment variables, and updating the system PATH.

```bash
# Example directory structure:
hadoop-3.3.1/bin/winutils.exe

# Set environment variable:
HADOOP_HOME=C:\path\to\hadoop-3.3.1

# Add to PATH:
set PATH=%HADOOP_HOME%\bin;%PATH%
```

--------------------------------

### Using OptionsStrategy for Traversal Configurations (Verbose)

Source: https://tinkerpop.apache.org/docs/3.4.13/upgrade

Demonstrates how to use `OptionsStrategy` to set arbitrary configurations on a `Traversal` using the verbose `build()` and `create()` methods. These configurations can be accessed by graph providers for custom step implementations.

```gremlin
g.withStrategies(OptionsStrategy.build().with("specialLimit", 10000).create()).V();
```

--------------------------------

### Install Neo4j Dependency for Gremlin Server

Source: https://tinkerpop.apache.org/docs/3.3.0/reference

Installs the Neo4j-Gremlin dependency into the Gremlin Server's extension directory using the `install` command with Maven coordinates. This makes the dependency available for use when the server starts.

```bash
bin/gremlin-server.sh install org.apache.tinkerpop neo4j-gremlin 3.3.0
```

--------------------------------

### Get Help for a Specific Command (:help :plugin)

Source: https://tinkerpop.apache.org/docs/4.0.0-SNAPSHOT/tutorials/the-gremlin-console

To get detailed usage information for a specific command, use the :help command followed by the command name. This example shows how to get help for the :plugin command, which manages console plugins.

```groovy
gremlin> :help :plugin
```

--------------------------------

### Windows Build Setup

Source: https://tinkerpop.apache.org/docs/3.7.1-SNAPSHOT/dev/developer

Instructions for setting up a Windows environment to build TinkerPop. This involves installing winutils for Hadoop and configuring environment variables.

```bash
# Example: Set HADOOP_HOME environment variable
HADOOP_HOME=C:\\path\\to\\hadoop-3.3.1

# Example: Add HADOOP_HOME\bin to PATH
set PATH=%HADOOP_HOME%\\bin;%PATH%
```

--------------------------------

### Install Gremlin Python and Configure Gremlin Server

Source: https://tinkerpop.apache.org/docs/3.4.9/reference

This snippet demonstrates the command to install the `gremlin-python` package for Gremlin Server and then start the server with a Python-enabled configuration. The installation command only needs to be run once. The configuration file `conf/gremlin-server-modern-py.yaml` is used to enable the `GremlinJythonScriptEngine`.

```bash
$ bin/gremlin-server.sh install org.apache.tinkerpop gremlin-python 3.4.9
$ bin/gremlin-server.sh conf/gremlin-server-modern-py.yaml
[INFO] GremlinServer - 
       \
       (o o)
---oOOo-(3)-oOOo---

[INFO] GremlinServer - Configuring Gremlin Server from conf/gremlin-server-modern-py.yaml
[INFO] MetricManager - Configured Metrics Slf4jReporter configured with interval=180000ms and loggerName=org.apache.tinkerpop.gremlin.server.Settings$Slf4jReporterMetrics
[INFO] GraphManager - Graph [graph] was successfully configured via [conf/tinkergraph-empty.properties].
[INFO] ServerGremlinExecutor - Initialized Gremlin thread pool.  Threads in pool named with pattern gremlin-*
[INFO] ScriptEngines - Loaded gremlin-jython ScriptEngine
[INFO] ScriptEngines - Loaded gremlin-python ScriptEngine
[INFO] ScriptEngines - Loaded gremlin-groovy ScriptEngine
[INFO] GremlinExecutor - Initialized gremlin-groovy ScriptEngine with scripts/generate-modern.groovy
[INFO] ServerGremlinExecutor - Initialized GremlinExecutor and configured ScriptEngines.
[INFO] ServerGremlinExecutor - A GraphTraversalSource is now bound to [g] with graphtraversalsource[tinkergraph[vertices:0 edges:0], standard]
[INFO] OpLoader - Adding the standard OpProcessor.
[INFO] OpLoader - Adding the session OpProcessor.
[INFO] OpLoader - Adding the traversal OpProcessor.
[INFO] TraversalOpProcessor - Initialized cache for TraversalOpProcessor with size 1000 and expiration time of 600000 ms
[INFO] GremlinServer - Executing start up LifeCycleHook
[INFO] Logger$info - Loading 'modern' graph data.
[WARN] AbstractChannelizer - The org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV3d0 serialization class is deprecated.
[INFO] AbstractChannelizer - Configured application/vnd.gremlin-v3.0+gryo with org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV3d0
[WARN] AbstractChannelizer - The org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV3d0 serialization class is deprecated.
[INFO] AbstractChannelizer - Configured application/vnd.gremlin-v3.0+gryo-stringd with org.apache.tinkerpop.gremlin.driver.ser.GryoMessageSerializerV3d0
[INFO] AbstractChannelizer - Configured application/vnd.gremlin-v3.0+json with org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV3d0
[INFO] AbstractChannelizer - Configured application/json with org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV3d0
[INFO] AbstractChannelizer - Configured application/vnd.graphbinary-v1.0 with org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1
[INFO] AbstractChannelizer - Configured application/vnd.graphbinary-v1.0-stringd with org.apache.tinkerpop.gremlin.driver.ser.GraphBinaryMessageSerializerV1
[INFO] GremlinServer$1 - Gremlin Server configured with worker thread pool of 1, gremlin pool of 8 and boss thread pool of 1.
[INFO] GremlinServer$1 - Channel started at port 8182.

```

--------------------------------

### Build and Deploy SNAPSHOT with Maven

Source: https://tinkerpop.apache.org/docs/3.6.0/dev/developer

These commands are used to build the project, deploy the SNAPSHOT version, and publish documentation. First, `mvn clean install -DskipTests` builds the project to ensure the correct console version is used. Then, `mvn deploy -DskipTests` deploys the SNAPSHOT artifacts. Finally, `bin/process-docs.sh` and `bin/publish-docs.sh` are used to generate and publish the SNAPSHOT documentation.

```bash
mvn clean install -DskipTests
mvn deploy -DskipTests
bin/process-docs.sh
bin/publish-docs.sh <username>
```
Tokens:
Raw