[11/15開催: PostgreSQL Conference Japan 2019 参加受付中] 
他のバージョンの文書 11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

36.6. 基本的な文

本節および次節では、明示的にPL/pgSQLで解釈される、全ての種類の文について説明します。 これらの種類の文として認められないものは全て、SQLコマンドであると仮定され、(その文で使用されるPL/pgSQL変数を全て代入した後で)メインデータベースエンジンに送信され実行されます。 したがって、例えば、INSERTUPDATEDELETE SQLコマンドは、PL/pgSQLの文とみなすことができます。しかし、ここではこれらについては言及しません。

36.6.1. 代入

値を変数、もしくは行/レコードフィールドに代入する場合は以下のように記述します。

identifier := expression;

上述した通り、このような文中にある式は、メインデータベースエンジンに送信されるSELECT SQLコマンドによって評価されます。 式は1つの値を生成しなければなりません。

式の結果データ型が変数のデータ型に一致しない場合、または、変数が(char(20)のように)特定の大きさ/精度を持つ場合、結果の値は PL/pgSQLインタプリタによって、結果の型の出力関数と変数の型の入力関数を使用して暗黙的に変換されます。 これにより、結果値の文字列形式を入力関数で受け付けることができない場合に、入力関数において実行時エラーが発生する可能性があることに注意してください。

例:

user_id := 20;
tax := subtotal * 0.06;

36.6.2. SELECT INTO

複数列を持つ(しかし1行のみの)SELECTコマンドの結果は、レコード変数、行型の変数、スカラ変数のリストに代入することができます。 これは、以下によって行われます。

SELECT INTO target select_expressions FROM ...;

ここで、targetはレコード変数、行変数、あるいは、単純な変数とレコード/行変数のフィールドをカンマで区切ったリストです。 select_expressionsとコマンドの残りの部分は通常のSQLと同じです。

これは、INTOの対象は新しく作成されるテーブルであるという、PostgreSQLの通常のSELECT INTOの実装とは大きく異なります。 PL/pgSQL 関数内部でSELECTの結果からテーブルを作成したい場合は、CREATE TABLE ... AS SELECT構文を使用してください。

行または変数リストが対象に使用された場合、選択された値は正確に対象の構造に一致しなければなりません。 さもなければ、実行時エラーが発生します。 レコード変数が対象の場合は、自動的に問い合わせ結果の列の行型に自動的に自身を設定します。

INTO句以外は、このSELECT文は通常のSELECT SQLコマンドと同一であり、SELECTの全ての機能を使用することができます。

INTO句はSELECT文のほとんど任意の場所に記述することができます。 習慣的には、上に示したようにSELECTの直後またはFROMの直前、すなわちselect_expressionsの直前または直後に記述されます。

問い合わせが行を返さない場合、NULL値が対象に代入されます。 問い合わせが複数の行を返す場合、最初の行が対象に代入され、残りは破棄されます ("最初の行"ORDER BYを使用していない限り完全に明確にならないことに注意してください)。

SELECT INTO文の後で特殊なFOUND変数(項36.6.6を参照)を検査することにより、代入が正しく行われたかどうかを、つまり問い合わせによって少なくとも1行が返されたかどうかを確認できます。

SELECT INTO myrec * FROM emp WHERE empname = myname;
IF NOT FOUND THEN
    RAISE EXCEPTION 'employee % not found', myname;
END IF;

IS NULL条件を使用して、レコードもしくは行結果がNULLかどうかを検査することができます。 しかし、他の行が存在し破棄されたかどうかを判断する方法は存在しないことに注意してください。 以下に、行がまったく返されなかった場合を扱う例を示します。

DECLARE
    users_rec RECORD;
BEGIN
    SELECT INTO users_rec * FROM users WHERE user_id=3;

    IF users_rec.homepage IS NULL THEN
        -- ユーザがhomepageを入力しなかったので"http://"を返す。
        RETURN 'http://';
    END IF;
END;

36.6.3. 結果を返さない式、もしくは問い合わせの実行

結果を必要としない問い合わせや式の評価を行いたいことがあります(直接得られる結果は必要がなくても、副次的に得られる結果に意味を見出す関数の呼び出しが典型的)。 これをPL/pgSQLで行うには、PERFORM文を使用してください。

PERFORM query;

これはqueryを実行し、その結果を破棄します。 SQLのSELECT文と同じ方法でqueryを記述しますが、最初のキーワードSELECTPERFORMに置き換えてください。 PL/pgSQL変数は通常通り問い合わせ内で置き換えられます。 また、特殊な変数であるFOUNDは問い合わせ結果が1行でも生成された場合は真に設定され、生成されない場合は偽に設定されます。

注意: INTO句を持たないSELECTでこの結果を果たすことができると考えるかもしれませんが、現時点では、これを行う方法はPERFORMしかありません。

以下に例を示します。

PERFORM create_mv('cs_session_page_requests_mv', my_query);

36.6.4. まったく何もしない

何もしないプレースホルダ文が有用になることがあります。 例えば、IF/THEN/ELSE文の一部が空文であることを明示したい時です。 このような目的には、NULL文を使用します。

NULL;

例えば、次の2つのコードは同等です。

    BEGIN
        y := x / 0;
    EXCEPTION
        WHEN division_by_zero THEN
            NULL;  -- 誤りを無視する
    END;

    BEGIN
        y := x / 0;
    EXCEPTION
        WHEN division_by_zero THEN  -- 誤りを無視する
    END;

どちらが望ましいと思うかは、好みの問題です。

注意: OracleのPL/SQLでは、無記述の文は許されないのでNULL文が必須となります。 それに反して PL/pgSQLでは、無記述の文が許可されています。

36.6.5. 動的コマンドの実行

PL/pgSQL関数の内部で、動的コマンド、つまり実行する度に別のテーブルや別のデータ型を使用するコマンドがほしいということがよくあるでしょう。 PL/pgSQLが通常行うコマンドの計画のキャッシュはこのような状況では動作しません。 この種の問題を扱うために、以下のEXECUTE文が用意されています。

EXECUTE command-string [ INTO target ];

ここで、command-stringは実行されるコマンドを含む(text型の)文字列に従った評価式で、 targetはレコード変数、行変数、あるいは、単純な変数とレコード/行変数のフィールドをカンマで区切ったリストです。

このコマンド文字列上へのPL/pgSQL変数の置換は行われないことには、特に注意してください。 変数の値は、コマンド文字列を作成する時に埋め込まなければなりません。

PL/pgSQLにおける他の全てのコマンドとは異なり、EXECUTEによって実行されるコマンドはセッションの有効期間中一度だけ解釈、保存されるわけではありません。 代わりに、コマンドは文が実行される時に準備されます。 コマンド文字列は、異なるテーブルと列に対する操作を実行できるように、関数内部で動的に作成することができます。

INTO句は、SELECTコマンドの結果を代入するべき場所を指定します。 行または変数リストが用いられるとき、それはSELECTで作成された結果の構造と正確に一致しなければなりません。 (レコード変数が使用されるとき、それは自分自身を結果の構造と自動的に一致させます)。 複数の行が返されたとき、最初の行だけがINTO変数に代入されます。 1行も返されないとき、NULL がINTO変数に代入されます。 INTO句が指定されないとき、SELECTの結果は捨てられます。

SELECT INTOEXECUTEでは現在サポートされません。

動的コマンドを実行する時、PL/pgSQLでは単一引用符をエスケープしなければなりません。 推奨されるのは、関数本体における固定のテキストをドル引用符で囲む方法です (ドル引用符を用いない旧式のコードを保有している場合は、項36.2.1の概要を参照することが、理解しやすいコードへの変換作業の手助けになります)。

作成した問い合わせに挿入すべき動的な値は、それ自身の内部に引用符を含む可能性があるため、特別な処理が必要です。 以下に例を示します(ここでは関数にドル引用符を用いる方法を使用すると仮定しているので、引用符を二重化する必要はありません)。

EXECUTE 'UPDATE tbl SET '
        || quote_ident(colname)
        || ' = '
        || quote_literal(newvalue)
        || ' WHERE key = '
        || quote_literal(keyvalue);

この例は、quote_identquote_literal関数の使用方法を示しています。 安全のため、列とテーブルの識別子を含んでいる式はquote_ident関数を通さなければなりません。 動的に構築されるコマンド内で、リテラル文字列となるべき値を含んでいる式はquote_literal関数を通さなければなりません。 両方とも、適切な処理を行い、入力されたテキストを単一引用符もしくは二重引用符で括り、特殊文字を全て適切にエスケープして埋め込んだものを返します。

ドル引用符の用法は一定のテキストを囲む時だけ有用だということに注意してください。 上の例を次のようにするのは、とても悪い考えです。

EXECUTE 'UPDATE tbl SET '
        || quote_ident(colname)
        || ' = $$'
        || newvalue
        || '$$ WHERE key = '
        || quote_literal(keyvalue);

なぜなら、newvalueの内容がたまたま$$を含む時は、途中で次の処理へ移ってしまうからです。 同様の不測事態は、ドル引用符の他の区切り文字を選んだ時も起こります。 したがって、テキストの内容が既知でない時は、安全のためにquote_literal関数を使用しなければなりません

動的問い合わせとEXECUTEの長大な例は例36-6で見ることができます。 それは新しい関数を定義するためにCREATE FUNCTIONコマンドを用いて実行するものです。

36.6.6. 結果ステータスの取得

コマンドの効果を判断するには、いくつか方法があります。 最初の方法は、以下のような形式のGET DIAGNOSTICSを使用する方法です。

GET DIAGNOSTICS variable = item [ , ... ];

このコマンドによって、システムステータスインジケータを取り出すことができます。 各itemは、指定された変数に割り当てられた状態値を識別するためのキーワードです(これは受け取るために正しいデータ型でなければなりません)。 現在使用可能なステータス項目は、ROW_COUNTRESULT_OIDの2つです。 ROW_COUNTは、最後にSQLエンジンに送信されたSQLコマンドによって処理された行数を示します。 RESULT_OIDは、最も最近のSQLコマンドによって挿入された最後の行のOIDです。 RESULT_OIDはOID を保有するテーブルへのINSERTコマンドの後でのみ有意であることに注意してください。

以下に例を示します。

GET DIAGNOSTICS integer_var = ROW_COUNT;

2番目のコマンドの効果を判断する方法は、FOUNDというboolean型の特殊な変数をチェックすることです。 PL/pgSQLの各関数内で使用される際、FOUNDは最初は偽に設定されています。 以下のように、それぞれの文の種類によって設定が変更されます。

FOUNDは各々のPL/pgSQL関数内部のローカル変数です。 FOUNDに対して行われた全ての変更は、現在の関数にのみ影響します。