Gephi :remote options

[Fred Eisele]

I had other processes using the default port so I started the gephi streaming service with port 28080.
The documentation for the tinkerpop.gephi is related to usage not configuration.
I was able to get it working by adding additional :remote command options.

:remote connect tinkerpop.gephi workspace1 localhost 28080

This did the trick but I am wondering is this described in the documentation or javadoc?

[Stephen Mallette]

There is a table of configuration options in the Gephi plugin section - the "port" option is listed among them:

https://tinkerpop.apache.org/docs/current/reference/#gephi-plugin

--
You received this message because you are subscribed to the Google Groups "Gremlin-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to gremlin-user...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/gremlin-users/57750df8-c242-41ed-9e27-65d2427cce5fn%40googlegroups.com.

[Fred Eisele]

As I understand it there are three ways to configure a :remote.
1) using the :remote config command
2) during the :remote connect command as additional arguments
3) during the :remote connect command via a configuration file

It is always possible to circumvent the :remote mechanism all together.
For example,
* https://tinkerpop.apache.org/docs/current/reference/#gremlin-java-connecting
* https://tinkerpop.apache.org/docs/current/reference/#tinkergraph-gremlin
These former examples are written in Java but, for the Gremlin shell, are fairly easy to rewrite in Groovy.

I am looking for :remote documentation relating these different approaches.
Here is what I have so far.

The basic gremlin shell is based on the groovy shell.

http://groovy-lang.org/groovysh.html

But, the groovy shell has been extended with additional commands.

In particular :remote.

The gremlin shell provides some help via :help :remote

https://tinkerpop.apache.org/docs/current/tutorials/the-gremlin-console/#help

gremlin> :help :remote
usage: :remote [current | connect <type-of-remote> [<args>] | config <args> | list | next | prev | choose <index> | close]
There can be multiple :remotes at the same time. Only one of them is active. They can be shown with :remote list.
Define and manage remote connections to use in conjunction with the :submit command, which will send Gremlin scripts to the specified remote agent for processing.

Examples of :remote config is given
*  https://tinkerpop.apache.org/docs/current/reference/#gephi-plugin
* https://tinkerpop.apache.org/docs/current/reference/#console-aliases

Examples of :remote connect with files and arguments are

* https://tinkerpop.apache.org/docs/current/reference/#connecting-via-console

:remote is a custom groovysh command
http://groovy-lang.org/groovysh.html#GroovyShell-register

It appears that the source code for the commands can be found
https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands 
* :bytecode - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/BytecodeCommand.groovy
* :clear - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/ClsCommand.groovy
* :set - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/GremlinSetCommand.groovy
* :install - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/InstallCommand.groovy
* :plugin - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/PluginCommand.groovy 
* :remote - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/RemoteCommand.groovy
* :submit - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/SubmitCommand.groovy
* :uninstall - https://github.com/apache/tinkerpop/tree/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/UninstallCommand.groovy

Based on my reading of
https://github.com/apache/tinkerpop/blob/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/commands/RemoteCommand.groovy#L55
it appears that the first argument to :remote connect must be the name of the mediator plugin and the remaining arguments vary depending upon that plugin.
* https://github.com/apache/tinkerpop/blob/3.4.10/gremlin-console/src/main/java/org/apache/tinkerpop/gremlin/console/jsr223/DriverGremlinPlugin.java

* :remote connect tinkerpop.server

  * https://github.com/apache/tinkerpop/blob/3.4.10/gremlin-console/src/main/java/org/apache/tinkerpop/gremlin/console/jsr223/DriverRemoteAcceptor.java

The first positional argument must be either the path to a configuration file or the variable name for a cluster object
The second positional argument is optional but may be either "session" or "session-managed".
If the second positional argument is present an optional session name may be provided as the third argument.
These are the only connect arguments which the "tinkerpop.server" supports.

* :remote connect tinkerpop.gephi

  * https://github.com/apache/tinkerpop/blob/3.4.10/gremlin-console/src/main/groovy/org/apache/tinkerpop/gremlin/console/jsr223/GephiRemoteAcceptor.groovy

connect arguments: [the remaining arguments are obtained from the configuration parameters].

1) workspace
2) host

3) port

* :remote config - is specified for the currently active remote connection
* tinkerpop.server =  :remote config [timeout [<ms>|none] | alias [reset | show | <alias> <actual>] | help]
* tinkerpop.gephi = :remote config [host <host> | port <port> | workspace <name> | stepDelay <ms> | startRGBColor <0.0,0.0,0.0> | colorToFade [r|g|b] | colorFadeRate <0.0> | sizeDecrementRate <0.0> | startSize <0.0> | visualTraversa l  <graph> | help]