pipeline-ctrl コマンドリファレンス
pipeline-ctrlとはコマンドラインからパイプライン実行、各種設定、情報参照を行うためのツールです。
pipeline-ctrlの各コマンドをスクリプトファイルに記述することでバッチ的に処理を実行することもできます。
起動方法
pipeline-ctrlの実行ファイルは[INSTALL_DIR]/pipeline/bin/pipeline-ctrl(.bat)にあります。パスワードが空文字以外の場合、必ず起動時のオプションに-password:を指定します。
起動時のオプション
- -host:ホスト名
- 接続するパイプラインコーディネーターのホスト名。省略時は localhost
- -port:ポート番号
- 接続するパイプラインコーディネーターのポート番号。省略時は 25080
- -password:パスワード
-
ログイン用パスワード。
パスワードが空文字の場合は不要です。 - -script:ファイル名
-
起動後に実行するスクリプト。
-scriptが指定された場合、スクリプト実行後すぐに終了します。 - -output:ファイル名
-
実行コンソールのログファイル名。
-outputが指定された場合、コンソールでの出力内容がすべて指定ファイルに記録されます。
相対パスの指定
引数にファイル名を相対パスで指定したときの起点は、コマンドの実行ディレクトリになります。
コマンドの使い方
凡例
コマンドと引数
pipeline-ctrlを起動するとプロンプトが表示され、そこにコマンドを打ち込んでいくことで処理を行っていきます。
(DOSやUnixのシェルと同様の操作イメージです。)
コマンドは1~2語の単語で構成され、コマンドのみまたはコマンドに引数が必要なものがあります。
引数には、必須引数とオプション引数があります。
必須引数は、コマンドの直後にコマンドごとに決められた順序で指定します。
オプション引数は、「-password」のように「-」で始まるキーワードで指定します。オプションに値を指定する場合は「-password:guest」のように「:」で区切って値を指定します。値に空白を含める場合は「"-description:空白 あり"」のように引数全体を「"」で囲みます。必須引数と異なり、オプション引数は順不同で指定することができます。
//コマンドサンプル //「//」で始まる行はコメント
コマンド一覧
コマンド | 説明 |
---|---|
connect | コーディネーターにログインします |
disconnect | コーディネーターにログアウトします |
version | バージョン |
help | ヘルプ |
quit | pipeline-ctrlの終了 |
list pipeline | パイプラインリストを表示します |
list request | リクエストリストを表示します |
list systemdb | システムDBのテーブル、レコード一覧を表示します |
list statusdb | ステータス用データベースのテーブル、レコード一覧を表示します |
list actiondb | アクション用データベースのテーブル、レコード一覧を表示します |
exec | パイプラインを実行します |
pipeline resume | パイプラインを開始します |
pipeline suspend | パイプラインを停止します |
pipeline import | パイプラインをインポートします |
pipeline export | パイプラインをエクスポートします |
request detail | リクエストの詳細を出力します |
request retry | リクエストをリトライします |
request cancel | リクエストをキャンセルします |
clear pipeline | パイプラインの各アクションのキャッシュデータをクリアします |
clear table | パイプラインアクションで使用している内部DBのテーブルをクリアします |
clear drop | パイプラインアクションで使用している内部DBのテーブルをドロップします |
script | コマンドスクリプトを実行します |
spool | コンソールの出力内容をファイルに出力します |
timing | コマンドの実行時間を表示します |
alias | 別名を登録します |
connect
必須引数 | 説明 |
---|---|
第1引数 |
パスワードを指定します。 パスワードなしの場合は指定しません。 |
// パスワードを"password"として接続 connect password
disconnect
disconnect
version
//バージョン情報を表示します。 version
help
必須引数 | 説明 |
---|---|
第1引数 |
ヘルプを表示するコマンド名を指定します。 省略した場合はコマンド一覧が表示されます。 |
//execコマンドのヘルプを表示します。 help exec
quit
quit
list pipeline
パイプラインの一覧を表示します。
オプション引数キーワード | 値 | 説明 |
---|---|---|
-id | あり | 表示するパイプラインIDを指定します。 |
-sScCuUdD | なし | 小文字:表示、大文字:非表示 s S パイプラインの開始・停止状態 |
リストされるアイテム
- パイプラインID
- パイプライン名
- パイプラインの状態(開始・停止)
- 作成日付
- 更新日付
- 説明
- リクエストパラメータ
// パイプラインIDを表示 list pipeline // パイプラインIDを指定して作成日時と更新日時を表示 list pipeline -id:pl_00001 -cu > pl_00001 ファイル管理 Stop 2009-12-14T20:15:47.720 JST 2009-12-14T20:15:47.720 JST
list request
リクエストの一覧を表示します。
オプション引数キーワード | 値 | 説明 |
---|---|---|
-id | あり | リクエストを表示したいパイプラインIDを指定します。 |
-date | あり | 取得する日付をyyyyMMddの形式で指定します。 |
-error | あり |
on - エラーステータスのみリストします。 off - すべてのステータスをリストします。 |
-offset | あり | リストの取得を開始する行番号を指定します。 |
-max | あり | 一度に表示する最大リスト数を指定します。 |
リストされるアイテム
- リクエストID
- パイプラインID
- パイプライン名
- リクエストのステータス
- 開始時刻
- 現在のステージ情報
list request
list systemdb
システムDBのテーブル、レコード一覧を表示します。
オプション引数キーワード | 値 | 説明 |
---|---|---|
-table | あり | レコード一覧を表示するテーブル名を指定します。 |
-offset | あり | リストの取得を開始する行番号を指定します。 |
-max | あり | 一度に表示する最大リスト数を指定します。 |
テーブル一覧でリストされるアイテム
- テーブル名
レコード一覧でリストされるアイテム
- カラム1
- カラム2
- :
- カラムN
// テーブル一覧を表示 list systemdb > prev[---] [0/0] next[---] offset [0] count[3] > [1]tablename : > ACTIVEMQ_ACKS > ACTIVEMQ_LOCK > ACTIVEMQ_MSGS // レコードの一覧 list systemdb -table:ACTIVEMQ_LOCK > prev[---] [0/0] next[---] offset [0] count[1] > [1]ID :[2]TIME :[3]BROKER_NAME : > 1 -NULL- -NULL-
list statusdb
ステータス用データベースのテーブル、レコード一覧を表示します。
オプション引数キーワード | 値 | 説明 |
---|---|---|
-table | あり | レコード一覧を表示するテーブル名を指定します。 |
-offset | あり | リストの取得を開始する行番号を指定します。 |
-max | あり | 一度に表示する最大リスト数を指定します。 |
テーブル一覧でリストされるアイテム
- テーブル名
レコード一覧でリストされるアイテム
- カラム1
- カラム2
- :
- カラムN
// テーブル一覧を表示 list statusdb > prev[---] [0/0] next[---] offset [0] count[2] > [1]tablename : > STATUS20090324 > STATUS20090326 // レコードの一覧 list statusdb -table:STATUS20090324 > prev[---] [0/0] next[---] offset [0] count[2] > [1]REQUESTID :[2]PIPELINEID :[3]CREATED :[4]LASTUPDATED :[5]STAGE :[6]STATUS :[7]ERRORMSG :[8]ERROR : > pl_00001-20090324_18-000001 /pipeline.pl_00001 2009-03-24 18:21:02.685000000 2009-03-24 18:21:03.445000000 Finish 0 > pl_00001-20090324_19-000002 /pipeline.pl_00001 2009-03-24 19:10:20.694000000 2009-03-24 19:10:22.668000000 Finish 0
list actiondb
アクション用データベースのテーブル、レコード一覧を表示します。
オプション引数キーワード | 値 | 説明 |
---|---|---|
-table | あり | レコード一覧を表示するテーブル名を指定します。 |
-offset | あり | リストの取得を開始する行番号を指定します。 |
-max | あり | 一度に表示する最大リスト数を指定します。 |
テーブル一覧でリストされるアイテム
- テーブル名
レコード一覧でリストされるアイテム
- カラム1
- カラム2
- :
- カラムN
// テーブル一覧を表示 list actiondb > prev[---] [0/0] next[---] offset [0] count[1] > [1]tablename : > Test // レコードの一覧 list actiondb -table:Test > prev[---] [0/0] next[---] offset [0] count[3] > [1]item1 :[2]item2 :[3]item3 : > 1 2 3 > 4 5 7 > 6 7 8
exec
指定のパイプラインを実行します。
必須引数 | 説明 |
---|---|
第1引数 | 実行するパイプラインのパイプラインIDを指定します。 |
キーワード | 値 | 説明 |
---|---|---|
-p | あり |
//引数を指定してパイプラインを実行 exec pl_00001 -p:reqParam1=v1 -p:reqParam2=v2
pipeline resume
必須引数 | 説明 |
---|---|
第1引数 | 開始するパイプラインのパイプラインIDを指定します。 |
// pl_00001 のパイプラインを開始 pipeline resume pl_00001
pipeline suspend
必須引数 | 説明 |
---|---|
第1引数 | 停止するパイプラインのパイプラインIDを指定します。 |
// pl_00001 のパイプラインを停止 pipeline suspend pl_00001
pipeline import
必須引数 | 説明 |
---|---|
第1引数 | インポートするファイルパスを指定します。 |
// パイプラインをインポート pipeline import pipe/pipeline.par
pipeline export
コマンドの実行ディレクトリにpipeline.parが作成されます。
必須引数 | 説明 |
---|---|
第1引数 | エクスポートするパイプラインのパイプラインIDを指定します。 |
// パイプラインをすべてエクスポート pipeline export pipe/pipeline.par // パイプラインを指定してエクスポート pipeline export pl_00001 pl_00003 pl_00004 pl_00010
request detail
必須引数 | 説明 |
---|---|
第1引数 | 詳細を表示するリクエストのIDを指定します。 |
キーワード | 値 | 説明 |
---|---|---|
-sensorfile | なし | センサーの入力データを表示するときに指定します。 |
-requestlog | なし | リクエストログ情報を表示するときに指定します。 |
-applog | なし | アプリケーションログ情報を表示するときに指定します。 |
// リクエストの詳細を表示します request detail pl_0000x_xxxxx_xxxx // アプリケーションログとリクエストログを表示します request detail pl_00027-20091127_20-000001 -applog -requestlog > Id : pl_00027-20091127_20-000001 > Name : EndPipeline > Status : Finish > PipelineId : pl_00027 > Stage : Complete > BeginTime : 2009-11-27 08:13:52 > EndTime : 2009-11-27 08:13:52 > SensorTime : 00:00 > FilterTime : 00:00 > JointTime : 00:00 > > RequestLog > 2009/11/27 08:13:52 Start 0 > 2009/11/27 08:13:52 Sensor Start 0 > 2009/11/27 08:13:52 Sensor Start 1 > 2009/11/27 08:13:52 Sensor End 1 > 2009/11/27 08:13:52 Sensor End 0 > 2009/11/27 08:13:52 Filter Start 0 > 2009/11/27 08:13:52 Filter End 0 > 2009/11/27 08:13:52 Joint Start 0 > 2009/11/27 08:13:52 Joint Start 1 > 2009/11/27 08:13:52 Joint End 1 > 2009/11/27 08:13:52 Joint End 0 > 2009/11/27 08:13:52 End 0 > > ApplicationLog > 2 20:13:52 INFO センサーリクエストの送信を開始します。: pl_00027-20091127_20-000001 > 3 20:13:52 INFO センサーリクエストの送信を終了しました。: pl_00027-20091127_20-000001 > 4 20:13:52 INFO Processorの実行を開始します。: Filter > 5 20:13:52 INFO Processorの実行を終了しました。: Filter > 6 20:13:52 INFO Processorの実行を開始します。: Joint > 7 20:13:52 INFO ジョイントアクションの初期化が完了しました。: postFileDataAction > 8 20:13:52 INFO ジョイントアクションの実行を開始します。: postFileDataAction > 9 20:13:52 INFO ジョイントアクションの実行が終了しました。: postFileDataAction > 10 20:13:52 INFO ジョイントアクションの処理が終了しました。: postFileDataAction > 11 20:13:52 INFO Processorの実行を終了しました。: Joint
request retry
必須引数 | 説明 |
---|---|
第1引数 | リトライするリクエストのIDを指定します。 |
// リクエストをリトライします request retry pl_0000x_xxxxx_xxxx
request cancel
必須引数 | 説明 |
---|---|
第1引数 | キャンセルするリクエストのIDを指定します。 |
// リクエストをキャンセルします request cancel pl_0000x_xxxxx_xxxx
clear pipeline
必須引数 | 説明 |
---|---|
第1引数 | クリアするパイプラインのパイプラインIDを指定します。 |
キーワード | 値 | 説明 |
---|---|---|
-s | なし |
センサーステージのキャッシュをクリアします。 -Sとは同時に指定できません。 |
-S | なし |
センサーステージのキャッシュをクリアしません。 -sとは同時に指定できません。 |
-f | なし |
フィルターステージのキャッシュをクリアします。 -Fとは同時に指定できません。 |
-F | なし |
フィルターステージのキャッシュをクリアしません。 -fとは同時に指定できません。 |
-j | なし |
ジョイントステージのキャッシュをクリアします。 -Jとは同時に指定できません。 |
-J | なし |
ジョイントステージのキャッシュをクリアしません。 -jとは同時に指定できません。 |
// アクションのキャッシュをクリアします clear pipeline pl_00010
clear table
list actiondb で出力されたテーブルに対して実行できます。
必須引数 | 説明 |
---|---|
第1引数 | レコードをクリアするテーブル名を指定します。 |
// テーブルをクリアします clear table delte_table_name
clear drop
list actiondb で出力されたテーブルに対して実行できます。
必須引数 | 説明 |
---|---|
第1引数 | ドロップするテーブル名を指定します。 |
// テーブルをドロップします clear drop drop_table_name
script
必須引数 | 説明 |
---|---|
第1引数 | コマンドを記述したスクリプトファイル名を指定します。 |
第2引数 |
//script.txtというスクリプトファイルを実行します script script.txt
spool
ファイルへの書き込みはすべて追加書き込みです。
必須引数 | 説明 |
---|---|
第1引数 |
出力ファイル名またはon/offを指定します。 初回の実行では必ず出力ファイル名を指定しなければなりませんが、一度出力ファイルが設定された後はoff/onで出力を停止/再開できます。 |
//pipeline-ctrl.logというファイルに実行ログを出力します spool pipeline-ctrl.log
timing
必須引数 | 説明 |
---|---|
第1引数 |
処理時間の表示、非表示を指定します。 on - コマンド実行後に処理時間を表示します。 off - 処理時間を表示しません。 |
//コマンド処理時間を表示するモードに変更 timing on
alias
コマンドが入力された場合、最初に各単語のエイリアスを変換し、その後プロセッサーに渡されます。
初期状態で「quit」の別名として「exit」が登録されています。
必須引数 | 説明 |
---|---|
第1引数 | 別名として登録するワードを指定します。 |
第2引数 | 別名の対象とするワードを指定します。 |
//「XMLを作成するパイプライン」という単語の別名として「makeXmlPipeline」を登録します alias makeXmlPipeline XMLを作成するパイプライン