Gremlin Consoleの起動

対話型環境用Gremlin Consoleの起動。

Gremlinは、DSE Graphと対話するために使用するクエリー言語です。Gremlinコードを入力するための1つの方法は、Gremlin Consoleを使用することです。Gremlin Consoleは、Gremlinを直接入力して、グラフ・スキーマの作成、データの読み込み、グラフの管理、および探索結果の取得を行うための便利な対話型環境です。Gremlin ConsoleはDSE Graphと対話が可能なGremlin Serverとのインターフェイスです。

手順

Gremlin Consoleを起動するには、dseコマンドを使用して、追加のコマンドgremlin-consoleを渡します。
```
bin/dse gremlin-console
```
```
         \,,,/
         (o o)
-----oOOo-(3)-oOOo-----
plugin activated: tinkerpop.server
plugin activated: tinkerpop.utilities
plugin activated: tinkerpop.tinkergraph
gremlin>
```
デフォルトでは、以下に示すように3つのプラグインがアクティブ化されます。Gremlin Serverであるtinkerpop.serverが起動し、コマンドをDSE Graphに対して発行できるようになります。ユーティリティ・プラグインであるtinkerpop.utilitiesは、Gremlin Consoleで役に立つさまざまな関数、ヘルパー・メソッド、および外部クラスのインポートを提供します。一部のグラフ操作の媒介として使用されるインメモリー・グラフであるTinkerGraphは、tinkerpop.tinkergraphを使用して起動されます。Gremlin ConsoleはリモートのGremlin Serverに自動的に接続します。
注: DataStax Enterpriseに同梱されているGremlin Consoleでは、Apache TinkerPopに同梱されているGremlin Consoleのようなプラグインのインストールはできません。

Gremlin Consoleのヘルプを表示するには、-hフラグを使用します。

bin/dse gremlin-console -h

usage: gremlin.sh [options] [...]
  -C, --color                               Disable use of ANSI colors
  -D, --debug                               Enabled debug Console output
  -Q, --quiet                               Suppress superfluous Console
                                            output
  -V, --verbose                             Enable verbose Console output
  -e, --execute=SCRIPT ARG1 ARG2 ...        Execute the specified script
                                            (SCRIPT ARG1 ARG2 ...) and
                                            close the console on
                                            completion
  -h, --help                                Display this help message
  -i, --interactive=SCRIPT ARG1 ARG2 ...    Execute the specified script
                                            and leave the console open on
                                            completion
  -l                                        Set the logging level of
                                            components that use standard
                                            logging output independent of
                                            the Console
  -v, --version                             Display the version

ヒント: ファイルの読み込み時にすべての行を表示して、どのコードの行がエラーを発生させるかを検出するには、-Vを使用します。

特定のホストとポートを指定するには、host:portオプションを使用してGremlin Consoleを実行します。
```
bin/dse gremlin-console 127.0.0.1:8182
```
hostの指定には、任意のホスト名またはIPアドレスを使用できます。
1つまたは複数のスクリプトを実行するには、-eフラグを指定してGremlin Consoleを実行します。
```
bin/dse gremlin-console -e test1.groovy -e test2.groovy
```
スクリプトが正常に実行されると、実行後にプロンプトが表示されます。エラーが発生した場合は、標準出力によってエラーが示されます。
スクリプトの完了時にGremlin Consoleが開くようにするには、-eフラグの代わりに-iフラグを使用してGremlin Consoleを実行します。
```
bin/dse gremlin-console -i test1.groovy -i test2.groovy
```
スクリプトが正常に実行されると、実行後にGremlin Consoleのプロンプトが表示されます。エラーが発生した場合は、コンソールにエラーが示されます。

ヘルプを使用すると、Gremlin Consoleのすべてのコマンドに関する情報を取得できます。ConsoleコマンドはGremlin言語のコマンドではなく、シェル機能を提供するためにGremlin Consoleに対して発行されるコマンドです。Gremlin ConsoleはGroovyシェルに基づいています。

:help

For information about Groovy, visit:
    http://groovy-lang.org 

Available commands:
  :help       (:h  ) Display this help message
  ?           (:?  ) Alias to: :help
  :exit       (:x  ) Exit the shell
  :quit       (:q  ) Alias to: :exit
  import      (:i  ) Import a class into the namespace
  :display    (:d  ) Display the current buffer
  :clear      (:c  ) Clear the buffer and reset the prompt counter.
  :show       (:S  ) Show variables, classes or imports
  :inspect    (:n  ) Inspect a variable or the last result with the GUI object browser
  :purge      (:p  ) Purge variables, classes, imports or preferences
  :edit       (:e  ) Edit the current buffer
  :load       (:l  ) Load a file or URL into the buffer
  .           (:.  ) Alias to: :load
  :save       (:s  ) Save the current buffer to a file
  :record     (:r  ) Record the current session to a file
  :history    (:H  ) Display, manage and recall edit-line history
  :alias      (:a  ) Create an alias
  :register   (:rc ) Registers a new command with the shell
  :doc        (:D  ) Opens a browser window displaying the doc for the argument
  :set        (:=  ) Set (or list) preferences
  :uninstall  (:-  ) Uninstall a Maven library and its dependencies from the Gremlin Console
  :install    (:+  ) Install a Maven library and its dependencies into the Gremlin Console
  :plugin     (:pin) Manage plugins for the Console
  :remote     (:rem) Define a remote connection
  :submit     (:>  ) Send a Gremlin script to Gremlin Server

For help on a specific command type:
    :help command

Gremlin Consoleは、<TAB>キーを使用して可能なオプションのリストを表示する自動補完機能によりコードのヘルプを提供します。

注: :installおよび:pluginはDSE Graphには使用しないでください。これらのコマンドを使用すると、Gremlin Consoleでエラーが発生します。