ストアドプログラムの構文は、主に BEGIN ... END ブロック、DECLARE ステートメント、およびステートメントラベルの3つの部分で構成されています。
BEGIN ... ENDブロック
BEGIN ... END ブロックは複合ステートメントをサポートしており、ストアドプログラム(ストアドプロシージャ、ストアド関数、トリガー)の作成に使用されます。
BEGIN ... END の複合ステートメントには複数のステートメントを含めることができ、BEGIN と END キーワードで囲まれます。構文は以下のとおりです:
[begin_label:] BEGIN
[statement_list]
END [end_label]
ここで、statement_list は1つ以上のステートメントのリストを表し、各ステートメントはセミコロン(;)で終わります。statement_list はオプションなので、空の複合ステートメント BEGIN END も有効です。
BEGIN ... END ブロックはネストをサポートします。BEGIN ... END はラベル付けすることもできます。詳細については、ステートメントラベル を参照してください。
PLストアドプログラムのデフォルトの区切り文字は "/" ですが、ユーザーは delimiter コマンドを使用してカスタム区切り文字を設定し、定義全体を単一のステートメントとしてサーバーに渡すことができます。区切り文字は1文字または複数の文字で構成できますが、エスケープ文字として一般的に使用されるバックスラッシュ(\)文字の使用は避けてください。例:
DELIMITER $$
DELIMITER //
説明
OceanBaseデータベースで開発する場合、通常はカスタム区切り文字を設定する必要があります。PLブロック内部の定義に ; で区切られたステートメントが含まれない場合は、区切り文字を使用する必要はありません。
DECLAREステートメント
DECLARE ステートメントは、プログラムのローカル変数、例外処理、およびカーソルを定義するために使用されます。詳細については、それぞれ ストアドプログラムの変数、例外処理、およびカーソルを参照してください。
DECLARE は BEGIN ... END ブロック内でのみ使用が許可され、他のステートメントの前、つまりブロックの開始位置で使用する必要があります。
宣言は以下の順序で使用する必要があります:
カーソル宣言は例外処理プログラム宣言の前に記述する必要があります。
変数と条件宣言はカーソルまたは例外処理プログラム宣言の前に記述する必要があります。
ステートメントラベル
ラベルは BEGIN ... END ブロック内の LOOP、REPEAT、WHILE ステートメントで使用できます。構文は以下のとおりです:
[begin_label:] BEGIN
[statement_list]
END [end_label]
[begin_label:] LOOP
statement_list
END LOOP [end_label]
[begin_label:] REPEAT
statement_list
UNTIL search_condition
END REPEAT [end_label]
[begin_label:] WHILE search_condition DO
statement_list
END WHILE [end_label]
これらのステートメントのラベルは、以下のルールに従います:
begin_labelの後には必ずコロンを続けて記述します。begin_labelはend_labelなしで指定できます。end_labelが存在する場合は、begin_labelと一致している必要があります。begin_labelがない場合、end_labelを指定することはできません。同一のネストレベルのラベルは、互いに異なっている必要があります。
ラベルの最大長は16文字です。
構築済みのラベルを参照するには、ITERATE または LEAVE ステートメントを使用します。以下の例は、ラベルを使用してステートメントの反復を続行またはループを終了する方法です:
obclient> DELIMITER //
obclient> CREATE PROCEDURE doiterate()
BEGIN
DECLARE p1 INT DEFAULT 0;
label1: LOOP
SET p1 = p1 + 1;
IF p1 < 10 THEN ITERATE label1; END IF;
LEAVE label1;
END LOOP label1;
END //
Query OK, 0 rows affected
ブロック内の例外ハンドラーの宣言については、DECLARE ... HANDLERを参照してください。