CARDINALITY スカラー関数

CARDINALITY 関数は、配列のエレメント数を示すタイプ BIGINT の値を戻します。

構文図を読む構文図をスキップする CARDINALITY ( array-expression )

スキーマは SYSIBM です。

array-expression
配列タイプの SQL 変数、SQL パラメーター、またはグローバル変数か、配列タイプへのパラメーター・マーカーの CAST 指定。

結果

場合に応じて以下のようになります。
  • 通常配列の場合、戻り値は、エレメントが代入された配列の添字のうち、最大の添字になります。 これには、NULL 値が割り当てられたエレメントも含まれます。
  • 連想配列の場合、戻り値は、配列式で定義された固有の添字値の、実際の個数になります。

この関数は、配列が空であった場合には 0 を戻します。 結果は NULL になる可能性があります。 引数が NULL である場合、その結果は NULL 値になります。

例

  1. これまでに最新呼び出しリストに保管された呼び出しの数を戻します。 
       SET HOWMANYCALLS = CARDINALITY(RECENT_CALLS)
    SQL 変数 HOWMANYCALLS には値 3 が含まれます。
  2. 配列タイプ CAPITALSARRAY の連想配列変数 CAPITALS に、カナダの 10 の州と 3 つの地域の首都すべてと、国の首都オタワが含まれると想定します。配列変数のカーディナリティーを戻します。 
       SET NUMCAPITALS = CARDINALITY(CAPITALS)
    SQL 変数 NUMCAPITALS には値 14 が含まれます。