コマンドライン・インタフェース(CLI)は、インタラクティブに実行されるか、1つのコマンドの実行に使用されます。CLIを開始する一般的な使用方法は次のとおりです。
使用方法:
java -jar KVHOME/lib/kvstore.jar runadmin -host <hostname> -port <port> [single command and arguments]
スクリプト・ファイルを実行する場合、"load"コマンドをコマンドラインで使用できます。
使用方法:
java -jar KVHOME/lib/kvstore.jar.runadmin -host <hostname> -port <port> load -file <path-to-script>
オプションの引数が何も渡されていない場合は、インタラクティブに開始します。追加的な引数が渡されている場合は、実行してから返される1つのコマンドとして解釈されます。CLIのインタラクティブなプロンプトは次のとおりです。
"kv-> "
コマンドが正常に完了すると、CLIのプロセス終了コードはゼロです。エラーがある場合、終了コードはゼロ以外になります。
CLIには多数のコマンドが含まれますが、一部のコマンドにはサブコマンドがあります。複合的なコマンドは、情報を表示するための"show"やスキーマを操作するための"ddl"などの一般的な機能でグループ化されます。すべてのコマンドで次のフラグを使用できます。
-help
コマンドまたはサブコマンドのオンライン・ヘルプを表示します。
-verbose
コマンドの冗長出力を有効にします。
この付録ではコマンドとサブコマンドに関する次の情報が示されます。
使用方法:
connect -host <hostname> -port <registry port>
指定されたホストおよびレジストリ・ポートに接続して、管理機能を実行します。管理サービスがターゲット・ホストでアクティブである必要があります。このコマンドは、初期接続情報が消失したり不正確である場合に使用できます。
ストア内のスキーマを操作する作業をカプセル化します。サブコマンドは次のとおりです。
ストア内のスキーマの管理の詳細は、「Avroスキーマの管理」を参照してください。
使用方法:
ddl add-schema <-file <file> | -string <schema string>> [-evolve] [-force]
このサブコマンドを使用して、新規スキーマを追加するか、同じ名前で既存スキーマを変更(<evolve>)します。-evolveフラグを使用して、スキーマが変更されていることを示します。-forceフラグを使用して、変更の警告を無視してスキーマを追加します。
使用方法:
help [command [sub-command]]
ヘルプ・メッセージを出力します。引数がない場合は最上位のシェル・コマンドが一覧表示されます。追加的なコマンドおよびサブコマンドがある場合は、追加の詳細が示されます。
通常は非表示になっているパラメータの可視性と設定を切り替えます。このパラメータは、Oracle Supportでアドバイスされた場合のみ使用してください。
使用方法:
history [-last <n>] [-from <n>] [-to <n>]
コマンド履歴を表示します。デフォルトではすべての履歴が表示されます。表示範囲の選択にはオプションのフラグが使用されます。
使用方法:
load -file <path to file>
指定したファイルをロードし、その内容を実行対象のコマンドのスクリプトとして解釈します。スクリプト内のいずれかのコマンドが失敗した場合、実行はその時点で停止します。
ストア状態を変更する作業またはジョブをカプセル化します。interruptおよびwait以外のすべてのサブコマンドが永続的な状態を変更します。プランは非同期ジョブであるため、-waitが使用されていなければすぐに返されます。プラン・ステータスは"show plans"を使用してチェックできます。すべてのプラン用のオプションの引数は、次のとおりです。
-wait
プランが返される前に終了するまで待機します。
-plan-name
プランの名前。これらは一意です。
-noexecute
プランを実行しません。指定された場合、プランは後で"plan execute"を使用して実行できます。
-force
プラン実行およびプラン再試行を強制実行するために使用されます。
サブコマンドは次のとおりです。
使用方法:
plan change-mountpoint -sn <id> -path <path> -add | -remove
[-plan-name <name>] [-wait] [-noexecute]
[-force]
ストレージ・ノード上でマウント・ポイントを追加または削除します。
使用方法:
plan change-parameters -service <id> | -all-rns | -all-admins
[-dry-run] [-plan-name <name>] [-wait]
[-noexecute] [-force] -params [name=value]
指定されたサービス、または同じタイプのすべてのサービス・インスタンスのパラメータを変更します。-serviceフラグを使用すると1つのインスタンスが対象になります。-all-*フラグは、あるサービス・タイプのすべてのインスタンスを変更する際に使用できます。変更するパラメータは-paramsフラグの後に続き、スペースで区切られます。スペースが埋め込まれたパラメータ値は、name="value with spaces"のように引用符で囲む必要があります。-dry-runが指定された場合、変更は行われずに新規パラメータが返されます。
使用方法:
plan deploy-admin -sn <id> -port <http port> [-plan-name <name>]
[-wait] [-noexecute] [-force]
指定されたストレージ・ノードにAdminをデプロイします。このグラフィカル・インタフェースは指定されたポート上でリスニングします。
使用方法:
plan deploy-datacenter -name <datacenter name>
-rf <replication factor> [-plan-name <name>]
[-wait] [-noexecute] [-force]
指定されたデータ・センターをストアにデプロイします。
ストアには現在、1つのデータ・センターのみが存在できます。
使用方法:
plan deploy-sn -dc <id> | -dcname <name> -host <host> -port <port>
[-plan-name <name>] [-wait] [-noexecute] [-force]
指定されたホストおよびポートにおけるストレージ・ノードを指定されたデータ・センターにデプロイします。
使用方法:
plan execute -id <id> | -last [-wait] [-force]
作成済でまだ実行されていないプランを実行します。プランは、-noexecuteフラグを使用して事前に作成されているはずです。-lastを使用して、最も最近作成されたプランを参照します。
使用方法:
plan interrupt -id <plan id> | -last
実行中のプランを中断します。中断されたプランは再実行または取消のみが可能です。-lastを使用して、最も最近作成されたプランを参照します。
使用方法:
plan cancel -id <plan id> | -last
実行中ではないプランを取り消します。実行中のプランを取り消すにはその前に中断する必要があります。-lastを使用して、最も最近作成されたプランを参照します。
使用方法:
plan migrate-sn -from <id> -to <id> [-admin-port <admin port>]
[-plan-name <name>] [-wait] [-noexecute] [-force]
あるストレージ・ノードから別のストレージ・ノードにサービスを移行します。古いノードは実行中ではないことが必要です。古いノードが管理サービスをホストしていた場合は、-admin-port引数が必要です。
使用方法:
plan remove-sn -sn <id> [-plan-name <name>]
[-wait] [-noexecute] [-force]
指定されたストレージ・ノードをトポロジから削除します。
使用方法:
plan start-service -service <id> | -all-rns [-plan-name <name>]
[-wait] [-noexecute] [-force]
指定されたサービスを開始します。
使用方法:
plan deploy-topology -name <topology name> [-plan-name <name>]
[-wait] [-noexecute] [-force]
指定されたトポロジをストアにデプロイします。この操作は、ストアのサイズおよび状態によって、時間がかかる場合があります。
使用方法:
change-policy [-dry-run] -params [name=value]*
まだデプロイされていないサービスに適用される、ストア全体ポリシーのパラメータを変更します。変更するパラメータは-paramsフラグの後に続き、スペースで区切られます。
スペースが埋め込まれたパラメータ値は、name="value with spaces"のように引用符で囲む必要があります。-dry-runが指定された場合、変更は行われずに新規パラメータが返されます。
リソース割当てに使用されるストレージ・ノード・プールを操作するコマンドをカプセル化します。サブコマンドは次のとおりです。
使用方法:
pool create -name <name>
ストアの作成または変更時にリソース・ディストリビューションに使用される、新規ストレージ・ノード・プールを作成します。
ストアおよびそのコンポーネントの状態を表示するコマンドをカプセル化します。サブコマンドは次のとおりです。
使用方法:
show parameters -policy | -service <name>
指定されたサービスのサービス・パラメータおよび状態を表示します。サービスはrg1-rn1、sn1、admin2などの任意の有効な文字列で識別されるような、RepNode、StorageNodeまたは管理サービスである可能性があります。-policyフラグを使用してグローバル・ポリシー・パラメータを表示します。
使用方法:
show events [-id <id>] | [-from <date>] [-to <date> ]
[-type <stat | log | perf>]
イベント詳細またはストア・イベントのリストを表示します。ステータス・イベントは、サービス・ステータスの変更を示します。
ログ・イベントは、注意が必要な場合は示されます。
パフォーマンス・イベントは通常クリティカルではありませんが、調査する必要があります。SEVEREとマークされたイベントは常に調査する必要があります。
次の日付/時間の形式を使用できます。これはローカル・タイム・ゾーンで解釈されます。
| MM-dd-yy HH:mm:ss:SS |
| MM-dd-yy HH:mm:ss |
| MM-dd-yy HH:mm |
| MM-dd-yy |
| HH:mm:ss:SS |
| HH:mm:ss |
| HH:mm |
使用方法:
show faults [-last] [-command <command index>]
失敗しているコマンドを表示します。デフォルトではすべての使用可能な失敗コマンドが表示されます。個々の失敗の詳細は、-lastおよび-commandフラグを使用して表示できます。
使用方法:
show plans [-id <id> | -last]
指定されたプランの詳細を表示するか、対応するプランIDおよびステータスとともに作成されているすべてのプランを一覧表示します。-lastを使用して、最も最近作成されたプランの詳細を表示します。
使用方法:
show schemas [-disabled] | [-name <name>]
指定されたスキーマのスキーマ詳細、またはストアに登録されているスキーマのリストを表示します。-disabledフラグは、無効になっているスキーマのリストを有効にします。
使用方法:
show snapshots [-sn <id>]
指定されたストレージ・ノード上のスナップショットを一覧表示します。ストレージ・ノードが指定されていない場合、ストアからストレージ・ノードが1つ選択されます。このコマンドを使用して既存のスナップショットを表示できます。
バックアップおよびリストアに使用されるスナップショットを作成および削除するコマンドをカプセル化します。サブコマンドは次のとおりです。
ストア・トポロジを操作するコマンドをカプセル化します。例としてノードの再配布/再均衡化、またはレプリケーション係数の変更があります。トポロジはこのコマンドを使用して作成および変更されます。次に、"plan deploy-topology"コマンドを使用してデプロイされます。サブコマンドは次のとおりです。
使用方法:
topology change-repfactor -name <name> -pool <pool name>
-dc <id> | -dcname <name>
-rf <replication factor>
トポロジを変更して、指定されたデータ・センターのレプリケーション係数を新しい値に変更します。レプリケーション係数はこのとき減少しない可能性があります。
使用方法:
topology clone -from <from topology> -name <to topology>
または
topology clone -current -name <to topology>
既存のトポロジを、トポロジ変更操作に使用される新規のトポロジ候補にクローニングします。
使用方法:
topology create -name <candidate name> - pool <pool name>
-partitions <num>
指定されたストレージ・プールを使用して、指定されたパーティション数の新規トポロジを作成します。
使用方法:
topology move-repnode -name <name> -rn <id>
トポロジを変更して、指定されたRepNodeを、システムで選択された使用可能なストレージ・ノードに移動します。
使用方法:
topology preview -name <name> [-start <from topology>]
起動トポロジに関連して、指定されたトポロジに対して行われる変更をプレビューします。-startが指定されていない場合、現行トポロジが使用されます。このコマンドは、新規トポロジをデプロイする前に使用する必要があります。
使用方法:
topology rebalance -name <name> -pool <pool name>
[-dc <id> | -dcname <name>]
均衡の取れたトポロジを作成するため、指定されたトポロジを変更します。オプションの-dcフラグが使用されている場合、指定されたデータ・センターからのストレージ・ノードのみが操作に使用されます。
使用方法:
topology redistribute -name <name> -pool <pool name>
使用可能なリソースのより効率的な利用のためにリソースを再配布するため、指定されたトポロジを変更します。
使用方法:
topology validate [-name <name>]
指定されたトポロジを検証します。トポロジが指定されていない場合、現行トポロジが検証されます。検証ではviolationsとnotesが生成されます。
violationsは問題を引き起こす可能性があり、調査が必要です。
notesは情報的で、問題になる可能性はあるが予測も可能であるという、構成上の目立つ差異を示します。