ARRAY_PRIOR スカラー関数

ARRAY_PRIOR 関数は、指定の配列指標引数に関連した配列の次に小さな配列指標値を戻します。

スキーマは SYSIBM です。

array-expression: 配列タイプの SQL 変数、SQL パラメーター、またはグローバル変数か、配列タイプへのパラメーター・マーカーの CAST 指定。
array-index: 配列の指標のデータ・タイプに割り当て可能な値を指定します。有効な値には、データ・タイプの有効値が含まれます。

結果は、指定の array-index 値に関連した、配列で定義されている次に小さな配列指標値です。array-index が配列内の最大の指標配列値より大きい場合は、結果は配列内で定義されている最後の配列指標値になります。

関数の結果のデータ・タイプは、配列指標のデータ・タイプです。結果は NULL になることがあります。引数が NULL か、最初の引数のカーディナリティーがゼロか、または array-index の値が配列内の最初の指標値以下の場合には、結果が NULL 値になります。

例

通常配列変数 SPECIALNUMBERS 内の 2 番目の指標位置より前の、直前の指標値を SQL 変数 PREV_CONSTIDX に戻します。
```
SET PREV_CONSTIDX = ARRAY_PRIOR(SPECIALNUMBERS,2)
```
結果は、1 になります。
連想配列変数 PHONELIST があり、その指標値と電話番号は、'Home' が '4163053745'、'Work' が '4163053746'、'Mom' が '416-4789683' であるとします。この配列内の、指標値 'Work' より前の直前の指標の指標値を、X という名前の文字ストリング変数に割り当てます。
```
SET X = ARRAY_PRIOR(PHONELIST, 'Work')
```
X には値 'Mom' が割り当てられます。次は、指標値 'Home' より前の配列の指標値を割り当てます。
```
SET X = ARRAY_PRIOR(PHONELIST, 'Home')
```
NULL 値が X に割り当てられます。