他のバージョンの文書 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

35.2. PL/pgSQLによる開発向けのヒント

PL/pgSQLで開発する一つの良い方法は、関数を作成するのに自分の好きなテキストエディタを使い、もう一つのウィンドウで、psqlを使用して関数を読み込ませて試験を行なうことです。 この方法で行う場合にはCREATE OR REPLACE FUNCTIONを使用して関数を作成する方がよいでしょう。 この方法によりファイルを再読み込みすることで、関数定義を更新することができます。 例えば、以下のようにします。

CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $$
          ....
$$ LANGUAGE plpgsql;

psqlを実行し、以下のように関数定義ファイルを読み込み、または、再読み込みすることができます。

\i filename.sql

その後すぐに、関数を試験するためにSQLコマンドを発行することができます。

PL/pgSQLにおける開発のもう一つの良い方法は、手続き言語の開発機能を持つGUIデータベースアクセスツールを使用することです。 他にもありますが、PgAccessがこうしたツールの一例です。 こうしたツールは、単一引用符をエスケープさせたり、関数の作り直しやデバッグが容易に行えたりする便利な機能をよく持っています。

35.2.1. 引用符の扱い

PL/pgSQL 関数のコードは CREATE FUNCTION 内で文字列リテラルとして指定されます。 単一引用符で囲む通常のやり方で文字列リテラルを記述する時、関数本体内部の全ての単一引用符を二重化しなければなりません。 同様に、全てのバックスラッシュを二重化しなければなりません。 引用符を単に重ねるやり方は最も冗長であり、簡単に想像できると思いますが、複雑な状態では数個以上の隣接した引用符が必要となるため、コードを率直には理解しにくくなります。 それに代わって推奨されるのは、関数本体を"ドル引用符"の文字列リテラルとして記述することです (項4.1.2.2を見てください)。 ドル引用符を用いるやり方では他の引用符を二重化する必要はありませんが、その代わり入れ子の段階ごとに、ドル引用符の異なった区切り文字の選択に注意する必要があります。 例えば、CREATE FUNCTION コマンドを以下のように記述できます。

CREATE OR REPLACE FUNCTION testfunc(integer) RETURNS integer AS $PROC$
          ....
$PROC$ LANGUAGE plpgsql;

このやり方では、SQL コマンドの中で単純なリテラル文字列に対して引用符を使用でき、文字列として集積したSQLコマンドの断片を区切るために $$ を使用できます。もし $$ を含んだテキストを引用符で囲むときは、$Q$ のような記述を使用できます。

以下の表はドル引用符を用いないときの引用符の記述法を示したものです。 ドル引用符を用いる以前における引用符の記述を理解するのに、この表は役立つと思われます。

1つの引用符

関数本体の先頭と末尾。 以下に例を示します。

CREATE FUNCTION foo() RETURNS integer AS '
          ....
' LANGUAGE plpgsql;

関数本体内部では、引用符は必ずペアで現れます。

2つの引用符

関数本体内部の文字列リテラル用。 以下に例を示します。

a_output := ''Blah'';
SELECT * FROM users WHERE f_name=''foobar'';

ドル引用符を用いるときは、次にように記述します。

a_output := 'Blah';
SELECT * FROM users WHERE f_name='foobar';

どちらも、PL/pgSQL パーサから見ると同一となります。

4つの引用符

関数本体内部の文字列リテラル内の単一引用符がある場合。 以下に例を示します。

a_output := a_output || '' AND name LIKE ''''foobar'''' AND xyz''

実際にa_outputに追加される値は、 AND name LIKE 'foobar' AND xyz.です。

ドル引用符を用いるときは、次にように記述します。

a_output := a_output || $$ AND name LIKE 'foobar' AND xyz$$

なお、ドル引用符の区切り文字は $$ だけとは限らないことに注意してください。

6つの引用符

関数本体内部の文字列内の単一引用符が、文字列定数の末尾にある場合。 以下に例を示します。

a_output := a_output || '' AND name LIKE ''''foobar''''''

実際にa_outputに追加される値は、 AND name LIKE 'foobar'.です。

ドル引用符を用いるときは、次にようになります。

a_output := a_output || $$ AND name LIKE 'foobar'$$

10個の引用符

文字列定数内に 2つの単一引用符を持たせたい場合 (これで 8 個の単一引用符になり)、かつ、この文字列定数の末尾にある場合 (これで2個追加されます)。 おそらく、他の関数を生成する関数を作成する場合例35-5のみにこれが必要になるでしょう。 以下に例を示します。

a_output := a_output || '' if v_'' || 
    referrer_keys.kind || '' like '''''''''' 
    || referrer_keys.key_string || '''''''''' 
    then return ''''''  || referrer_keys.referrer_type 
    || ''''''; end if;''; 

a_outputの値は以下のようになります。

if v_... like ''...'' then return ''...''; end if;

ドル引用符を用いるときは、次にようになります。

a_output := a_output || $$ if v_$$ || referrer_keys.kind || $$ like '$$
    || referrer_keys.key_string || $$'
    then return '$$  || referrer_keys.referrer_type 
    || $$'; end if;$$; 

ここに単一引用符は使用前に再評価されるため、a_output 内部だけで必要であると仮定します。

関数本体内部で引用符をエスケープする別の方法として、二重にするのではなくバックスラッシュを使用する方法があります。 この方法を使えば '''' の代わり に\'\' と書くことができることが判るでしょう。 これが維持を簡単にすると考える人も考えない人もいます。