B 管理CLIリファレンス
この付録では、次のコマンドについて説明します。
コマンドライン・インタフェース(CLI)は、インタラクティブに実行されるか、1つのコマンドの実行に使用されます。CLIを開始する一般的な使用方法は次のとおりです。
java -Xmx64m -Xms64m \
-jar KVHOME/lib/kvstore.jar runadmin \
-host <hostname> -port <port> [single command and arguments]
-security KVROOT/security/client.security
スクリプト・ファイルを実行する場合、"load"コマンドをコマンドラインで使用できます。
java -Xmx64m -Xms64m \
-jar KVHOME/lib/kvstore.jar runadmin -host <hostname> -port <port> \
-security \
KVROOT/securtiy/client.security \
load -file <path-to-script>
オプションの引数が何も渡されていない場合は、インタラクティブに開始します。追加的な引数が渡されている場合は、実行してから返される1つのコマンドとして解釈されます。CLIのインタラクティブなプロンプトは次のとおりです。
"kv-> "
コマンドが正常に完了すると、CLIのプロセス終了コードはゼロです。エラーがある場合、終了コードはゼロ以外になります。
CLIには多数のコマンドが含まれますが、一部のコマンドにはサブコマンドがあります。複合的なコマンドは、情報を表示するための"show"やスキーマを操作するための"ddl"などの一般的な機能でグループ化されます。すべてのコマンドで次のフラグを使用できます。
-
-help
コマンドまたはサブコマンドのオンライン・ヘルプを表示します。
-
?
-helpと同じ意味です。コマンドまたはサブコマンドのオンライン・ヘルプを表示します。
-
-verbose
コマンドの冗長出力を有効にします。
CLIコマンドの一般的な形式は次のとおりです。
-
コマンドはすべて、次のような構造になります。
"kv-> command [sub-command] [arguments]
-
引数はすべて、"-"で始まるフラグを使用して指定します。
-
コマンドとサブコマンドでは大/小文字は区別されず、可能な場合は一部の文字列(接頭辞)で照合されます。ただし、引数では大/小文字が区別されます。
CLIスクリプト・ファイルの中では、#
を使用してコメントを記入できます。また、行の終わりに円記号(\
)を付けると、コマンドを次の行に続けることができます。