SUBSTR スカラー関数
SUBSTR 関数は、ストリングのサブストリングを戻します。
スキーマは SYSIBM です。
- string
- サブストリングの派生元ストリングを指定する入力式。 式は、組み込みの文字ストリング、数値、ブール値、または日時値である値を返す必要があります。 文字ストリングでない値は、関数の評価の前に VARCHAR に暗黙的にキャストされます。 この式のサブストリングは、この式の任意の数 (ゼロ以上) の連続ストリング単位で構成されます。 start
- サブストリングを計算する起点となる、入力式の先頭からの相対位置を指定する式。 以下に例を示します。
- 位置 1 は、入力式における 1 番目のストリング単位です。 ステートメント
SUBSTR('abcd',1,2)は'ab'を返します。 - 位置 2 は、位置 1 から右方に 1 つ目の位置です。 ステートメント
SUBSTR('abcd',2,2)は'bc'を返します。
length - 位置 1 は、入力式における 1 番目のストリング単位です。 ステートメント
- 結果の長さを指定する式。 指定する場合、式は組み込み数値、CHAR、VARCHAR、GRAPHIC、または VARGRAPHIC のいずれかのデータ・タイプの値を戻す必要があります。 値がタイプ INTEGER でない場合、その値は関数を評価する前に暗黙的に INTEGER にキャストされます。 整数の値は、0 から Nの範囲でなければなりません。ここで、 N は、( ストリング ストリング単位の長さ属性)- 開始 + 1 と等しくなります (範囲外の場合は SQLSTATE 22011)。
length を明示的に指定した場合、string の右側に必要な数のブランク文字 (文字ストリングの場合は 1 バイト、GRAPHIC ストリングの場合は 2 バイト) が、またバイナリー・ストリングの場合には必要な数の 16 進ゼロ文字がそれぞれ効率的に付加されて、指定したサブストリングが存在するようにされます。 デフォルトの長さは、 開始 で指定されたストリング単位から ストリングの最後の ストリング単位 までの ストリング単位 の数です。 ただし、string が可変長ストリングで、 その長さが start 未満の場合、デフォルト値はゼロになり、 結果は空ストリングになります。 これは、アプリケーション・コード・ページではなく、データベース・コード・ページのコンテキスト内にあるストリング単位の数として指定しなければなりません。 (例えば、データ・タイプ VARCHAR(18)、値 'MCKNIGHT' の列 NAME の場合、
SUBSTR(NAME,10)では空ストリングが戻されます。)string の値に応じて、次のようになります。- 固定長ストリングの場合、デフォルトの長さは
LENGTH(string) - start + 1です。 - 可変長ストリングの場合、デフォルトの長さはゼロまたは
LENGTH(string) - start + 1のいずれか長いほうになります。
- 固定長ストリングの場合、デフォルトの長さは
結果
string が文字ストリングの場合、結果は、 その最初の引数のコード・ページおよびストリング単位で示された文字ストリングになります。 バイナリー・ストリングの場合には、結果もバイナリー・ストリングになります。 GRAPHIC ストリングの場合は、 結果も最初の引数のコード・ページおよびストリング単位で示された GRAPHIC ストリングになります。 バイナリー・ストリングでも FOR BIT DATA 文字ストリングでもないホスト変数が最初の引数である場合、結果のコード・ページは、データベースのコード・ページになります。 SUBSTR 関数のいずれかの引数が NULL 値の可能性がある場合、 結果も NULL 値になる可能性があります。 いずれかの引数が NULL 値の場合、結果は NULL 値になります。
表 1 は、SUBSTR 関数の結果タイプと長さが、その入力のタイプと属性に依存することを示しています。
| ストリング引数のデータ・タイプ | 長さ引数 | 結果データ・タイプ |
|---|---|---|
| CHAR(A) | 定数 (l<n) ストリング の単位は、以下のとおりです。
|
CHAR (L) |
| CHAR(A) | 指定しない。start 引数は定数 | CHAR (A-開始+ 1) |
| CHAR(A) | 定数以外 | VARCHAR(A) |
| VARCHAR(A) | 定数 (l<n) ストリング の単位は、以下のとおりです。
|
CHAR (L) |
| VARCHAR(A) | constant (m<l<n) ストリング の単位は、以下のとおりです。
|
VARCHAR (l) 型 |
| VARCHAR(A) | 定数以外、または指定しない。 | VARCHAR(A) |
| CLOB(A) | 定数 (l) | CLOB (l) |
| CLOB(A) | 定数以外、または指定しない。 | CLOB(A) |
| GRAPHIC(A) | 定数 (l<n) ストリング の単位は、以下のとおりです。
|
GRAPHIC (l) |
| GRAPHIC(A) | 指定しない。start 引数は定数 | GRAPHIC (A-開始+ 1) |
| GRAPHIC(A) | 定数以外 | VARGRAPHIC(A) |
| VARGRAPHIC(A) | 定数 (l<n) ストリング の単位は、以下のとおりです。
|
GRAPHIC (l) |
| VARGRAPHIC(A) | constant (m<l<n) ストリング の単位は、以下のとおりです。
|
VARGRAPHIC (l) |
| VARGRAPHIC(A) | 定数以外 | VARGRAPHIC(A) |
| DBCLOB(A) | 定数 (l) | DBCLOB (l) |
| DBCLOB(A) | 定数以外、または指定しない。 | DBCLOB(A) |
| BINARY(A) | 定数 (l< 256) | バイナリー (l) |
| BINARY(A) | 指定しない。start 引数は定数 | BINARY (A-開始+ 1) |
| BINARY(A) | 定数以外 | VARBINARY(A) |
| VARBINARY(A) | 定数 (l< 256) | バイナリー (l) |
| VARBINARY(A) | 定数 (255 <l< 32673) | VARBINARY (l) |
| VARBINARY(A) | 定数以外、または指定しない。 | VARBINARY(A) |
| BLOB(A) | 定数 (l) | BLOB (l) |
| BLOB(A) | 定数以外、または指定しない。 | BLOB(A) |
注
- 動的 SQL では、string、start、および length を、パラメーター・マーカーで表すことができます。 string にパラメーター・マーカーが使用されると、 オペランドのデータ・タイプは VARCHAR になり、 オペランドは NULL 可能になります。
- 上記の結果定義には明確には述べられていませんが、 この意味体系は、string が 1 バイト文字/マルチバイト文字混合ストリングの場合、 start と length の値によっては、 結果にマルチバイト文字のフラグメントが入る可能性があるということを暗黙に示しています。 例えば、場合によっては、結果がマルチバイト文字の 2 番目のバイトから始まったり、マルチバイト文字の最初のバイトで終わったりする可能性があります。 SUBSTR 関数は、このようなフラグメント化の検出を行わず、 またこのようなフラグメント化があっても特別な処理は何も行われません。
例
- 例 1: ホスト変数
NAME (VARCHAR(50))に値'BLUE JAY'が含まれると想定します。- 以下のステートメントでは、
'BLUE'という値が戻されます。SUBSTR(:NAME,1,4) - 以下のステートメントでは、
'JAY'という値が戻されます。SUBSTR(:NAME,6) - 以下のステートメントでは、
'JA'という値が戻されます。SUBSTR(:NAME,6,2)
- 以下のステートメントでは、
- 例 2: PROJECT 表から、
語 'OPERATION' で始まるプロジェクト名 (PROJNAME) の行を全選択します。
定数の最後にあるスペースは、'OPERATIONAL' などの語を除外するために必要です。SELECT * FROM PROJECT WHERE SUBSTR(PROJNAME,1,10) = 'OPERATION '