EDQコマンドライン・インタフェースの使用

5 EDQコマンドライン・インタフェースの使用

この章では、EDQコマンドライン・インタフェースを使用する方法を説明します。

この章の内容は次のとおりです。

EDQコマンドライン・インタフェースjmxtools.jarは、多数のEDQ機能へのアクセスを提供します。

コマンドライン・インタフェースの実行

EDQコマンドライン・インタフェースは、toolsディレクトリで自己完結型.jarファイルとして配布され、次のコマンドラインの起動により実行されます。

java -jar jmxtools.jar commandname arguments

次の項で、コマンドおよび引数について説明します。

コマンドおよび引数の理解

コマンドライン・インタフェースにより、複数のコマンドを実行でき、次のような機能を使用できます。

ジョブの実行
孤立した結果表のリスト表示および削除
ユーザー・セッション・ログの表示
リアルタイム・ジョブの停止
EDQバージョン番号の確認

後続の項では、使用可能なコマンド、引数およびオプションの完全なガイドを示します。

EDQでは、RESTベースのEDQ構成APIインタフェースを通じたジョブのサポートも提供されます。これらのインタフェースを使用して様々なジョブを実行する方法の詳細は、『Enterprise Data Qualityと外部システムの統合』の「ジョブ用のRESTインタフェース」を参照してください。

`runjob`

runjobコマンドは、ディレクタUIを使用してジョブを実行する場合と同じ方法で、指定されたジョブを実行します。runjobコマンドには、次の引数を指定します。

引数	使用方法
`-job` `job_name`	実行するジョブの名前を指定します。
`-project` `project_name`	ジョブを含むプロジェクトの名前を指定します。
-`u` `user_name`	EDQサーバーへの接続に使用するユーザー名を指定します。ユーザーは、ジョブを実行する権限と、ジョブを含むプロジェクトに対する権限を持っている必要があります。
-`p` `password`	接続ユーザーのパスワードを指定します。-pオプションを設定しないと、ユーザーはパスワードの入力を求められます。
`-nolockwait`	ジョブに使用されるいずれかのリソースがロックされている場合に、ジョブでそれらが使用可能になるまで待機しないことを示します。かわりに、それは失敗コード付きで終了し、コマンドラインに制御が戻されます。`-nolockwait`引数にその他の値は不要です。
`-nowait`	コマンドラインでジョブが完了するまで待機しないことを示します。`-nowait`引数にその他の値は不要です。
`server:port`	JMX (管理)インタフェースのサーバーおよびポートを指定します。

`runopsjob`

runopsjobコマンドは、サーバー・コンソールのユーザー・インタフェースを使用してジョブを実行する場合と同じ方法で、指定されたジョブを実行します。これは、runjobコマンドに対して、実行ラベルと実行プロファイルを使用する機能が追加されたものです。実行ラベルを使用すると、結果を同じジョブの他の実行結果と分けて保存することができます。実行プロファイルを使用すると、外部化された構成設定を実行時に上書きできます。

runopsjobコマンドには、次の引数を指定します。

引数	使用方法
`-job` `job_name`	実行するジョブの名前を指定します。
`-project` `project_name`	ジョブを含むプロジェクトの名前を指定します
`-u` `user_name`	EDQサーバーへの接続に使用するユーザー名を指定します。ユーザーは、ジョブを実行する権限と、ジョブを含むプロジェクトに対する権限を持っている必要があります。
`-p` `password`	接続ユーザーのパスワードを指定します。`-p`オプションを設定しないと、ユーザーはパスワードの入力を求められます。
-`nolockwait`	ジョブに使用されるいずれかのリソースがロックされている場合に、ジョブでそれらが使用可能になるまで待機しないことを示します。かわりに、それは失敗コード付きで終了し、コマンドラインに制御が戻されます。`-nolockwait`引数にその他の値は不要です。
`-nowait`	コマンドラインでジョブが完了するまで待機しないことを示します。`-nowait`引数にその他の値は不要です。
`-runlabel` `run_label_name`	ステージング済出力結果を格納する実行ラベルの名前を指定します。これは、実行プロファイルまたは`-D runlabel` = `run_label_name`で指定された実行ラベルをオーバーライドするため、注意してください。
`-props` `run_profile_name`	ジョブの外部化された構成オプションのオーバーライド設定を含む実行プロファイルのプロパティ・ファイルへのフルパスを指定します。
`-D` `externalized_option`=`value`	ジョブの特定の外部化されたオプションを個別にオーバーライドできます。外部化されたオプションおよび値の構文は、実行プロファイルのプロパティ・ファイルで使用されるものと同じです。文字はコマンドラインによって解釈されるため、一部の文字は、使用している環境のシェルの表記規則に従ってエスケープする必要があることに注意してください。また、個別の指定による外部化されたオプション設定は、それらが同じ実行で使用される実行プロファイルに指定されている場合、同じオプションの設定をオーバーライドすることに注意してください。
`server:port`	JMX (管理)インタフェースのサーバーおよびポートを指定します。

`droporphans`

droporphansコマンドは、プロセスが予期せず終了したときに作成されることのある孤立した結果表を削除するために使用します。これは、EDQサーバーでジョブまたはプロセスが実行されている場合には実行できません。

droporphansコマンドには、次の引数を指定します。

オプション	使用方法
`-u` `user name`	EDQサーバーへの接続に使用するユーザー名を指定します。ユーザーは、ジョブを取り消す権限と、ジョブを含むプロジェクトに対する権限を持っている必要があります。
`-p` `password`	接続ユーザーのパスワードを指定します。`-p`オプションを設定しないと、EDQによってパスワードを求めるプロンプトが表示されます。
`server:port`	JMX (管理)インタフェースのサーバーおよびポートを指定します。

`listorphans`

listorphansコマンドは、孤立した結果表を識別するために使用します。listorphansコマンドには、droporphansコマンドと同じ引数を指定します。

`scriptorphans`

scriptorphansコマンドは、孤立した結果表を削除するためにSQLコマンドのリストを作成します。これは、表を削除するときに結果データベースに対して実行するコマンドが正確かどうかを確認する場合、または表を手動で削除する場合に役立ちます。

`list`

listコマンドは、使用可能なすべてのコマンドをリスト表示します。

`showlogs`

showlogsコマンドは、ユーザー・セッション・ログを取得できる小さなグラフィカル・ユーザー・インタフェース・アプリケーションを起動します。

`shutdown`

shutdownコマンドは、すべてのリアルタイム・ジョブを停止します。これらは、リアルタイム・レコード・プロバイダ(WebサービスまたはJava Message Service)で実行されているジョブです。

shutdownコマンドには、次の引数を指定します。

オプション	使用方法
`-u` `user name`	EDQサーバーへの接続に使用するユーザー名を指定します。ユーザーは、ジョブを取り消す権限と、ジョブを含むプロジェクトに対する権限を持っている必要があります。
`-p` `password`	接続ユーザーのパスワードを指定します。`-p`オプションを設定しないと、ユーザーはパスワードの入力を求められます。
`-nowait`	コマンドラインでジョブが完了するまで待機しないことを示します。`-nowait`引数にその他の値は不要です。
`server:port`	JMX (管理)インタフェースのサーバーおよびポートを指定します。

`version`

versionコマンドは、EDQの現在インストールされているインスタンスのバージョンを識別するために使用します。

コマンドラインに、次の引数を入力します。

java -jar jmxtools.jar version

バージョン番号が戻されます。

例の確認

この項では、コマンドライン・インタフェースで使用可能ないくつかの起動例を示します。

使用可能なすべてのコマンドのリスト表示

次のコマンドライン・インタフェースの起動例では、使用可能なすべてのコマンドをリストします。

java -jar jmxtools.jar -list

出力は次のようになります。

Available launch names:	
<Job tools>	
runjob Run named job	
shutdown Shutdown realtime jobs	
runopsjob Run named job in operations mode	

<Logging>	
showlogs Show session logs	

<Database Tools>	
listorphans List orphaned results tables	
droporphans Drop orphaned results tables	
scriptorphans Create script for dropping orphaned results tables	

<System Information>	
version Display version number of tools

コマンドで使用可能なパラメータのリスト表示

対応するパラメータなしでコマンドを指定してコマンドライン・インタフェースを起動すると、そのコマンドの詳細なヘルプが出力されます。たとえば、runjobコマンドの詳細なヘルプを取得するには、次のようにコマンドライン・インタフェースを起動します。

java -jar jmxtools.jar runjob

出力は次のようになります。

Usage: runjob -job jobname -project project [-u user] [-p pw] [-nowait] [-nolockwait] [-sslprops props | -ssltrust store] server:port

指定したジョブの実行

この例では、(マシン名とポートの指定に従って)特定のEDQインスタンスで指定したプロジェクトの指定したジョブを実行する方法を示します。

ポート8090でJMXサーバーが稼働するローカル・マシンで、"dnadmin"というユーザー名を使用して"Audit"というプロジェクトの"rulecheck"というジョブを実行する場合、コマンドは次のようになります。

java -jar jmxtools.jar runjob -job rulecheck -project audit -u dnadmin localhost:8090

ユーザーは、dnadminユーザーのパスワードの入力を求められます。

操作モードでの指定したジョブの実行

この例では、Windows環境で、操作モードで指定したジョブを実行する方法を示します。操作モードでは、実行ラベルと実行プロファイルの機能にアクセスできるため、ジョブの構成を動的に指定したり、ジョブの結果を実行ラベルによって格納できます。

実行ラベル"Nov2011"および実行プロファイル・ファイルFile1.propertiesを使用して、ポート8090でJMXサーバーが稼働する"prod01"というサーバーで、"MDM"というプロジェクトの"profiling"というジョブを実行する場合、コマンドは次のようになります。

java -jar jmxtools.jar runopsjob -job profiling -project MDM -runlabel Nov2011 -props c:\ProgramData\Oracle\"Enterprise Data Quality\oedq_local_home\File1.properties" -u dnadmin prod01:8090