AGGMAPINFO

AGGMAPINFOファンクションは、アナリティック・ワークスペース内のaggmapオブジェクトの仕様に関する情報を返すファンクションです。

集計仕様(AGGMAP型のaggmapオブジェクト)に関する情報は、コンパイル後にのみ取得できます。集計仕様をコンパイルするには、COMPILE文を使用するか、またはFUNCDATAキーワードを指定してAGGREGATEコマンドを実行します。AGGMAPINFOファンクションで使用する前に集計仕様がコンパイルされていない場合は、AGGMAPINFOでコンパイルされます。ALLOCATEで使用するaggmapはコンパイルする必要がありません。

戻り値

要求する情報の種類によって異なります。詳細は、表7-1「AGGMAPINFOファンクションのchoiceパラメータのキーワード」を参照してください。

構文

AGGMAPINFO (name {choice | {choice-at-position rel-pos} })

パラメータ

name: aggmapオブジェクトの名前。
choice: 返される情報の種類を指定します。詳細は、表7-1「AGGMAPINFOファンクションのchoiceパラメータのキーワード」を参照してください。

表7-1 AGGMAPINFOファンクションのchoiceパラメータのキーワード

キーワード	データ型	説明
ADDED_MODELS	`TEXT`	AGGMAP ADDまたはREMOVEモデル文を使用して現在aggmapに追加されているモデル。モデルの名前を複数行のテキスト文字列で返す。
AGGINDEX	`BOOLEAN`	aggmapにあるAGGINDEX文の設定を示す。`YES`に設定すると、aggmapが再コンパイルされるたびにすべての使用可能な索引(コンポジット・タプル)が作成されることを示す。(AGGMAP型のaggmapにのみ適用。)
CHILDREN member-name	`TEXT`	MAINTAIN ADD SESSION文を使用して追加されるディメンション・メンバーで、一時計算メンバーを計算するために使用する方程式の右側に使用。メンバーの名前を複数行のテキスト文字列で返す。
CUSTOMMEMBERS	`TEXT`	MAINTAIN ADD SESSION文で追加されるメンバー。メンバーの名前を複数行のテキスト文字列で返す。
DIMENSION	`TEXT`	aggmapで使用されるモデルまたはリレーションのディメンションの名前。メンバーの名前を複数行のテキスト文字列で返す。
FCACHE	`BOOLEAN`	AGGREGATEファンクションのキャッシュがOracle OLAPにあるかどうかを示す。(AGGMAP型のaggmapにのみ適用。)
MAPTYPE	`TEXT`	aggmapの型。 AGGMAP文で仕様が入力されている場合、集計仕様の型としてAGGMAPを返す。この型のaggmapは、AGGREGATEコマンドまたはAGGREGATEファンクションでのみ使用可能。 ALLOCMAP文で仕様が入力されている場合、割当て仕様の型としてALLOCMAPを返す。この型のaggmapは、ALLOCATEでのみ使用可能。 aggmapは定義されているがAGGMAPまたはALLOCMAP文で仕様が入力されていない場合、`NA`を返す。
MODELS	`TEXT`	aggmapのモデル。モデルの名前を複数行のテキスト文字列で返す。
NUMRELS	`INTEGER`	aggmap仕様にあるRELATION文の合計数。
RELATIONS	`TEXT`	aggmap仕様のRELATION文で指定されているリレーションの名前。各文を別々の行で表示。
STORE	`BOOLEAN`	aggmapのCACHE文がSTOREに設定されているかどうかを示す。`YES`に設定すると、即時計算されるデータがキャッシュに格納されることを示す。(AGGMAP型のaggmapにのみ適用。)
VARIABLES	`TEXT`	AGGMAP ADDまたはREMOVEモデル文または$AGGMAPプロパティを使用してデフォルトのaggmapとして指定されているaggmapオブジェクトの変数。変数の名前を複数行のテキスト文字列で返す。

choice-at-position

返される情報を具体的に指定します。

PRECOMPUTEを指定すると、RELATION文のPRECOMPUTEキーワードの後にある制限句のテキストを返します。単一のRELATION文を指定するには、rel-pos引数を使用する必要があります。RELATION文にPRECOMPUTEキーワードがない場合はNAを返します。(AGGMAP型のaggmapにのみ適用。)

RELATIONを指定すると、rel-pos引数で指定したRELATION文の後にあるリレーションの名前を返します。

STATUSを指定すると、rel-pos引数で指定したRELATION文のPRECOMPUTE句をコンパイルした結果のステータス・リストを返します。(AGGMAP型のaggmapにのみ適用。)

rel-pos

aggmapのRELATION文を指定するINTEGER。このINTEGER値はRELATION文のリストにおける文の位置を示します。rel-pos引数はRELATION、PRECOMPUTEまたはSTATUSキーワードでのみ使用できます。たとえば、aggmapの最初のRELATION文に関する情報を取得するには、rel-pos引数としてINTEGER値の1を使用します。aggmapの4番目のRELATION文に関する情報を取得するには、INTEGER値の4を使用します(以降同様)。使用できるのは、1からaggmap仕様にあるRELATION文の合計数までの任意のINTEGER値です。aggmapオブジェクトのRELATION文の合計数を取得するには、NUMRELSキーワードを使用します。

例

例7-4 aggmapオブジェクトに関する情報の取得

sales.aggという名前のaggmapが次の文で定義されているとします。

DEFINE sales.agg AGGMAP <time, product, geography>

次の仕様がAGGMAP文でsales.aggに追加されているとします。

AGGMAP
RELATION time.r PRECOMPUTE (time ne 'Year98')
RELATION product.r
RELATION geography.r
CACHE STORE
END

aggmapに仕様が追加されている場合、AGGMAPINFOを使用してその仕様に関する情報を取得できます。

RELATION文で指定されている各階層の名前を参照するには、次の文を使用します。

SHOW AGGMAPINFO(sales.agg RELATIONS)

次の結果が表示されます。

time.r
product.r
geography.r

次の文と結果で、aggmapオブジェクトにあるRELATION文の数を取得できます。

SHOW AGGMAPINFO(sales.agg NUMRELS)
3

次の文と結果で、即時計算されるデータがセッションのキャッシュに格納されることを確認できます。aggmapにCACHE STORE文が含まれているので、結果はYESです。

show AGGMAPINFO(sales.agg STORE)
YES

次の文によって、aggmapにある2番目のRELATION文で指定されているリレーション名が表示されます。

SHOW AGGMAPINFO(sales.agg RELATION 2)
product.r

次の文によって、aggmapにある最初のRELATION文のPRECOMPUTEキーワードの後にある制限句が表示されます。

SHOW AGGMAPINFO(sales.agg PRECOMPUTE 1)
time NE 'YEAR98'

timeディメンション値がJan98からDec99、Year98およびYear99であるとします。次の文によって、aggmapにある最初のRELATION文のディメンションに対するステータス・リストが表示されます。

SHOW AGGMAPINFO(sales.agg STATUS 1)
Jan98 TO Dec99, Year99

RELATION文の制限句でtimeディメンション値がYear98と等しくないように指定されているので、Year98以外のすべてのtimeディメンション値がステータスに含まれます。

次の文によって、sales.aggのaggmapの型が表示されます。

SHOW AGGMAPINFO(sales.agg MAPTYPE)
AGGMAP