DESCRIBE

DESCRIBEコマンドは、1つ以上のワークスペース・オブジェクトの定義を示すレポートを生成するコマンドです。DESCRIBEコマンドの出力に表示されるオブジェクト定義には、説明(LD)、時間ディメンションの値名書式(VNF)、FORMULAに関連付けられている式、PERMIT文で指定されたアクセス権、計算仕様の内容(プログラムまたはモデルの内容など)などがあります。DESCRIBEを使用すると、オブジェクトへのアクセス権や、アクセス権を変更する権限が付与されていない場合でも、オブジェクトの定義を表示できます。オブジェクト定義の一部には、レポートされないものがあります(「DESCRIBEの出力でレポートされない内容」を参照)。

構文

DESCRIBE [names]

パラメータ

names: 空白またはカンマで区切られた、1つ以上のワークスペース・オブジェクトの名前。この引数を省略した場合、DESCRIBEはNAMEディメンションの現行のステータスにあるすべてのオブジェクトの定義を表示します。そのため、この引数を省略する場合は、DESCRIBEとLIMITコマンドを組み合せて使用することで、ワークスペース内の特定のオブジェクト・グループの定義をレポートできます(例9-109「すべてのリレーションに関する情報の表示」を参照)。

使用上の注意

DESCRIBEの出力でレポートされない内容

オブジェクト定義の一部は、DESCRIBEの出力に表示されません。

オブジェクトへのアクセス権を変更する権限がPERMIT文によって拒否された場合は、DESCRIBEにはこのオブジェクトの定義に関連付けられたアクセス権が含まれません。
ワークシート定義の場合、DESCRIBEレポートにはデフォルトのディメンションであるWKSCOLおよびWKSROWは含まれません。ただし、ユーザー定義ディメンションを使用してワークシートを定義した場合は、このユーザー定義ディメンションがレポートに含まれます。例9-110「ワークシートに関する情報の表示」を参照してください。
オブジェクトに関連付けられたプロパティおよびトリガーは表示されません。オブジェクトに関連付けられたプロパティおよびトリガーを表示するには、FULLDSCプログラムを使用する必要があります。
コンポジットまたは結合でデフォルトの索引タイプを使用するよう定義した場合、この情報は表示されません。
従来の1バイトまたは2バイト形式になっている、ディメンション化されたBOOLEAN変数は、WIDTH 1およびWIDTH 2としてリストされます。1ビット形式で作成されたBOOLEAN変数の幅は表示されません。

DESCRIBE出力を使用したオブジェクトの作成

DESCRIBEコマンドからの出力を使用すると、この出力の各行は有効な文であるため、他のワークスペースにオブジェクトを作成できます。たとえば、OUTFILE文を実行して後続の出力をファイルに送り、その後でDESCRIBEコマンドを実行できます。次に別のワークスペースにアクセスしてINFILE文を使用すると、DESCRIBE出力を読み取ることができます。これで、対象のワークスペースに同じオブジェクトが作成されます。

例

例9-108 変数に関する情報の表示

この例では、2つの変数salesおよびpriceの定義のレポートが生成されます。次の文

DESCRIBE sales price

によって、次の出力が生成されます。

DEFINE SALES VARIABLE DECIMAL <MONTH PRODUCT DISTRICT>
LD Sales Revenue
DEFINE PRICE VARIABLE DECIMAL <MONTH PRODUCT>
LD Wholesale Unit Selling Price

例9-109 すべてのリレーションに関する情報の表示

ワークスペース内にあるすべてのリレーションの定義を参照するとします。最初にOBJファンクションを使用して、NAMEディメンションを制限します。NAMEを制限したら、引数を指定しないでDESCRIBEコマンドを使用し、定義のレポートを生成します。次の文により、アナリティック・ワークスペース内のリレーションの説明が生成されます。

LIMIT NAME TO OBJ(TYPE) EQ 'RELATION'
DESCRIBE

DEFINE REGION.DISTRICT RELATION REGION <DISTRICT>
LD REGION for each DISTRICT 
DEFINE DIVISION.PRODUCT RELATION DIVISION <PRODUCT>
LD DIVISION for each PRODUCT 
DEFINE MLV.MARKET RELATION MARKETLEVEL <MARKET>
DEFINE MARKET.MARKET RELATION MARKET <MARKET> 
LD Self-relation for the Market Dimension

OBJ(TYPE)によって返される値は必ず大文字であるため、一致する結果を得るには、LIMITコマンドで、'relation'ではなく'RELATION'を使用する必要があります。

例9-110 ワークシートに関する情報の表示

情報が表示されるワークシートのディメンションは、ユーザー定義ディメンションのみです。デフォルトのディメンションであるWKSCOLおよびWKSROWは、説明には含まれていません。次の文

DEFINE work1 WORKSHEET
DEFINE columns DIMENSION INTEGER
DEFINE rows DIMENSION INTEGER
DEFINE work2 WORKSHEET <columns rows>
DESCRIBE work1 work2

によって、次の出力が生成されます。

DEFINE WORK1 WORKSHEET
DEFINE WORK2 WORKSHEET <COLUMNS ROWS>