ストアドプログラムの構文は主に 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を参照してください。