[
https://issues.apache.org/jira/browse/TINKERPOP-1303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15928314#comment-15928314
]
ASF GitHub Bot commented on TINKERPOP-1303:
-------------------------------------------
GitHub user spmallette opened a pull request:
https://github.com/apache/tinkerpop/pull/573
TINKERPOP-1303 Adds help option to :remote config command
https://issues.apache.org/jira/browse/TINKERPOP-1303
Here's the output for "help" in the plugins that support `:remote` as an
option in the console:
```text
gremlin> :remote connect tinkerpop.gephi
==>Connection to Gephi - http://localhost:8080/workspace1 with
stepDelay:1000, startRGBColor:[0.0, 1.0, 0.5], colorToFade:g,
colorFadeRate:0.7, startSize:10.0,sizeDecrementRate:0.33
gremlin> :remote config help
==>: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>|visualTraversal <graph>|help]
gremlin> :remote connect tinkerpop.server conf/remote.yaml
==>Configured localhost/127.0.0.1:8182
gremlin> :remote config help
==>:remote config [timeout [<ms>|none]|alias [reset|show|<alias>
<actual>]|help]
gremlin> :remote connect tinkerpop.hadoop graph g
==>useTraversalSource=graphtraversalsource[hadoopgraph[gryoinputformat->gryooutputformat],
sparkgraphcomputer]
==>useSugar=false
gremlin> :remote config help
==>:remote config [useSugar [true|false]|useTraversalSource
<traversalSourceName>|help]
```
This was a pretty simple change, but since @pluradj added this ticket, I
opted submit this to vote so that he could review before merge instead of just
doing a CTR.
VOTE +1
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/apache/tinkerpop TINKERPOP-1303
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/tinkerpop/pull/573.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #573
----
commit cf8b6b97eb6fcd5a4f1a11f92da89ef24f8bca81
Author: Stephen Mallette <[email protected]>
Date: 2017-03-16T15:51:23Z
TINKERPOP-1303 Adds help option to :remote config command
----
> add help for :remote config for Gephi Plugin
> --------------------------------------------
>
> Key: TINKERPOP-1303
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1303
> Project: TinkerPop
> Issue Type: Improvement
> Components: console
> Affects Versions: 3.2.1
> Reporter: Jason Plurad
> Priority: Minor
>
> This idea came from reviewing the
> [patch|https://github.com/apache/incubator-tinkerpop/pull/308] for
> TINKERPOP-1297. Currently {{:remote config}} with no arguments returns an
> unfriendly message "Invalid config arguments - check syntax". It might be
> more user-friendly if {{:remote config}} either returned the existing
> configuration settings or if it listed some help.
> {{:remote config help}} could let the user know what parameters are
> available and how they can be configured. Or perhaps something similar to how
> {{:remote connect}} works when you leave out parameters would help lead the
> user down the path of getting the syntax right.
> Although I approached this from a Gephi perspective, it seems that the config
> options help must be based on the remote type, whether it is
> {{tinkerpop.gephi}} vs {{tinkerpop.server}} vs {{tinkerpop.hadoop}}.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
