オプション
-q QUERY,--query=QUERY— 実行するクエリ。このパラメーターを指定しない場合、clickhouse-keeper-clientは対話型モードで起動します。-h HOST,--host=HOST— サーバーのホスト。デフォルト値:localhost。-p N,--port=N— サーバーのポート。デフォルト値: 9181-c FILE_PATH,--config-file=FILE_PATH— 接続文字列の取得に使用する設定ファイルのパスを指定します。デフォルト値:config.xml。--password=PASSWORD— 認証用のパスワード。CLICKHOUSE_KEEPER_PASSWORD環境変数、または XML 設定ファイルの<zookeeper><password>でも設定できます。--identity=IDENTITY—digest認証スキームで使用する identity。CLICKHOUSE_KEEPER_IDENTITY環境変数、または XML 設定ファイルの<zookeeper><identity>でも設定できます。--connection-timeout=TIMEOUT— 接続タイムアウトを秒単位で設定します。デフォルト値: 10s。--session-timeout=TIMEOUT— セッションタイムアウトを秒単位で設定します。デフォルト値: 10s。--operation-timeout=TIMEOUT— 操作タイムアウトを秒単位で設定します。デフォルト値: 10s。--history-file=FILE_PATH— 履歴ファイルのパスを指定します。デフォルト値:~/.keeper-client-history。--log-level=LEVEL— ログレベルを設定します。デフォルト値:information。--no-confirmation— 指定すると、いくつかのコマンドで確認を求めません。デフォルト値は、対話型ではfalse、クエリではtrueです。--help— ヘルプメッセージを表示します。
環境変数
CLICKHOUSE_KEEPER_PASSWORD— コマンドラインで--passwordが指定されていない場合のデフォルトパスワードとして使用されます。CLICKHOUSE_KEEPER_IDENTITY— コマンドラインで--identityが指定されていない場合のデフォルトの identity として使用されます。
認証
--passwordコマンドライン引数CLICKHOUSE_KEEPER_PASSWORD環境変数--config-fileで指定した XML 設定ファイル内の<zookeeper><password>
--identity / CLICKHOUSE_KEEPER_IDENTITY / <zookeeper><identity> にも同じ優先順位が適用されます。
認証設定を含む XML 設定ファイルの例:
例
コマンド
ls '[path]' [watch_id]— 指定した path のノードを一覧表示します (デフォルト: cwd) 。必要に応じて、watch_idで識別される children watch を設定しますcd '[path]'— 作業 path を変更します (デフォルト.)cp '<src>' '<dest>'— ‘src’ ノードを ‘dest’ path にコピーしますcpr '<src>' '<dest>'— ‘src’ ノードのサブツリーを ‘dest’ path にコピーしますmv '<src>' '<dest>'— ‘src’ ノードを ‘dest’ path に移動しますmvr '<src>' '<dest>'— ‘src’ ノードのサブツリーを ‘dest’ path に移動しますexists '<path>' [watch_id]— ノードが存在する場合は1、存在しない場合は0を返します。必要に応じて、watch_idで識別される watch を設定しますset '<path>' <value> [version]— ノードの値を更新します。version が一致する場合にのみ更新します (デフォルト: -1)create '<path>' <value> [mode]— 指定した値で新しいノードを作成しますtouch '<path>'— 値に空文字列を持つ新しいノードを作成します。ノードがすでに存在する場合でも例外をスローしませんget '<path>' [watch_id]— ノードの値を返します。必要に応じて、watch_idで識別される data watch を設定しますwatch <watch_id> [timeout_seconds]—watch_idで識別される watch イベントを待機し、イベントタイプと path を出力します。timeout_secondsが指定されている場合は、指定した timeout 後にエラーを返しますrm '<path>' [version]— version が一致する場合にのみノードを削除します (デフォルト: -1)rmr '<path>' [limit]— サブツリーのサイズが limit より小さい場合、path を再帰的に削除します。確認が必要です (デフォルト limit = 100)flwc <command>— four-letter-word コマンドを実行しますhelp— このメッセージを表示しますget_direct_children_number '[path]'— 特定の path 配下にある直接の子ノード数を取得しますget_all_children_number '[path]'— 特定の path 配下にあるすべての子ノード数を取得しますget_stat '[path]'— ノードの stat を返します (デフォルト.)find_super_nodes <threshold> '[path]'— 指定した path について、子ノード数が threshold を超えるノードを見つけます (デフォルト.)delete_stale_backups— 現在は非アクティブなバックアップに使用されている ClickHouse ノードを削除しますfind_big_family [path] [n]— サブツリー内で family が最も大きい上位 n 個のノードを返します (デフォルト path =.and n = 10)sync '<path>'— プロセス間および leader 間でノードを同期しますreconfig <add|remove|set> "<arg>" [version]— Keeper クラスターを再構成します。/docs/en/guides/sre/keeper/clickhouse-keeper#reconfiguration を参照してください