# Dgraph Gatewayコマンド・ユーティリティについて

Dgraph Gatewayには、Dgraphノードをリストし、一括ロード・ポートを割り当て、バージョン情報を提供し、Dgraphのキャッシュ・ウォーミング操作を実行する、コマンド行インタフェースがあります。

Dgraph Gatewayコマンド・ユーティリティは、デフォルトでは$BDD_HOME/server/endeca-cmdディレクトリにあります。たとえば、BDDインストール・ディレクトリの名前が`BDD1.0`の場合、ディレクトリへのパスは次のようになります。

    /localdisk/Oracle/Middleware/BDD1.0/server/endeca-cmd

ディレクトリには、コマンドを実行できるスクリプト(名前は`endeca-cmd`)が含まれています。

`endeca-cmd`ユーティリティには、Javaランタイム環境(JRE)の実行が必要です。そのため、システムのPATH変数定義の先頭に、インストールされたJDKのbinディレクトリが含まれていることを確認してください。または、JAVA_HOME環境変数が正しく設定されていることを確認してください。

## コマンド

`endeca-cmd`スクリプトは、次のDgraph Gatewayコマンドを実行できます。

`endeca-cmd`ユーティリティでは、次のコマンドをサポートしています。
オプション | 説明
--- | ---
`allocate-bulk-load-port` | リーダー・ノードのホスト名および一括ロード・インタフェースに使用されるポートを返します。
`dump-session` | 指定されたセッションIDのDgraphのセッション情報を返します。
`list-compute-nodes` | クラスタ内で実行中のDgraphノードのリストを返します。
`version` | Dgraph GatewayのバージョンおよびDgraphのバージョン(Dgraphが現在実行中の場合)をリストします。
`warm-cache` | カスタムのウォームアップ・スクリプトを必要とせずに、Dgraphキャッシュをウォームします。

## 構文

`endeca-cmd`スクリプトを実行するための構文は、次のとおりです。

    endeca-cmd <operation> [operation options] [global options]

## オンライン・ヘルプの利用

`--help`オプションは、Dgraph Gatewayコマンドの使用方法のヘルプを提供します。全般的なヘルプを表示するための構文は、次のとおりです。

    endeca-cmd --help

特定のコマンドに関するヘルプを表示するための構文は、次のとおりです。

    endeca-cmd <operation> --help

この例では、`list-compute-nodes`コマンドの使用方法のヘルプを表示します。

    endeca-cmd list-compute-nodes --help