規則ファイル内の規則または規則グループに関する情報を表示します。
概要
注: このコマンドは、
cqdiagnostics.pl スクリプトからのみ実行できます。
このスクリプトには
コマンドで必要なすべてのパラメータに対応する変数が含まれています。
スクリプトを編集して、
describe コマンドと
記述する規則および規則グループの値を指定してから、スクリプトを実行してください。
このスクリプトは、Rational® ClearQuest®
インストール ディレクトリにインストールされています。
デフォルトのロケーションは
cquest–home–dir¥diagnostic¥cqdiagnostics.pl です。スクリプトの使用法の詳細については、「
RationalClearQuest Diagnostics ユーティリティの使用法」を参照してください。
- describe –rulefile rule_file [ –rulenames rule_names... | –rulegroups rule_groups... | –allrules ]
[ –locale locale_name ]
説明
describe サブコマンドは、
規則ファイル内の規則または規則グループに関する情報を表示します。この規則または規則グループは、
validate サブコマンドで使用されます。
validatedb サブコマンドに
ついて詳しくは、
r_validatedb.htm を参照してください。このサブコマンドは、指定されたオプションに基づいて、規則ファイル内の、個々の規則、指定されたグループ内の一連の規則、すべての規則のいずれかについての情報を提供します。ある 1 つのデータベースに照らしたテストに使用できるすべての規則と規則グループが、1 つの規則ファイルに格納されています。
それぞれの規則は、データベースの整合性を判別するために使用される制約を表します。規則グループは、規則の集まりです。
結果には、以下のプロパティが含まれます。
- 規則名。規則の名前です。
- 説明 (ある場合)。データベースを検証するために規則が使用する制約です。
- タイプ。規則が適用する制約の種類に基づいた、規則のカテゴリです。タイプの例には、
テーブル存在、列存在、フィールド値検証があります。
説明は、コンソールにのみ表示され、ログ ファイルには書き込まれません。
オプションと引数
- -rulefile
- describe の対象にする規則が入っている規則ファイルを指定します。このオプションは、規則ファイル内のすべての規則のリストと、それぞれの規則の概要を出力します。
規則ファイルへのフルパスを指定する必要があります。下記の 例 を参照してください。
- -rulenames
- describe の対象にする、規則ファイル内の 1 つまたは複数の規則の名前を指定します。
このオプションは、規則の概要をコンソールに出力します。1 つのコマンドで複数の規則を指定する場合、各規則名の間に 1 文字の空白を挿入してください。下記の 例 を参照してください。
- -rulegroups
- describe の対象にする、規則ファイル内の 1 つまたは複数の規則グループを指定します。
このオプションは、規則グループ内のすべての規則のリストを出力します。1 つのコマンドで複数の規則グループを指定する場合、各規則グループ名の間に 1 文字の空白を挿入してください。下記の 例 を参照してください。
- -allrules
- 規則ファイル内のすべての規則を describe の対象にします。このオプションは、規則ファイル内のすべての規則の概要を出力します。下記の 例 を参照してください。
- -locale
- 出力で使用する言語を指定します。結果ファイルとコンソールでは、代替言語が使用可能です。
ログ ファイルは、英語でのみ書き込まれます。下記の 例 を参照してください。
例
describe コマンドは、 以下のロケーションから実行する必要があります:
cquest–home–dir¥diagnostic¥注: このコマンドは、cqdiagnostics.pl スクリプトからのみ実行できます。
- 規則ファイル rules.xml 内のすべての規則の情報を表示します。
describe -rulefile cquest–home–dir¥diagnostic¥configuration¥rules.xml
- 規則ファイル rules.xml 内の規則 m_fielddef_type_rule と Master_links_link_type_rule の情報を表示します。
describe -rulefile cquest–home–dir¥diagnostic¥configuration¥rules.xml -rulenames m_fielddef_type_rule Master_links_link_type_rule
- 規則グループ table-existence と referential に属しているすべての規則をリストします。
describe -rulefile cquest–home–dir¥diagnostic¥configuration¥rules.xml -rulegroups table-existence referential