他のバージョンの文書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.11. Oracle PL/SQLからの移植

本節ではOracleからPostgreSQLへアプリケーションを移植する開発者の手助けとなるように、 PostgreSQLPL/pgSQL言語とOracleのPL/SQL言語の違いについて説明します。

PL/pgSQLは多くの点でPL/SQLに似ています。 それはブロックで構成されていて、厳格な言語であり、全ての変数は宣言されなければならない点です。 代入やループ、条件分岐も同様です。 PL/SQLからPL/pgSQLに移植する際に注意しなければならない、主な違いを以下に示します。

35.11.1. 移植例

例35-4に簡単な関数のPL/SQLからPL/pgSQLへの移植方法を示します。

例 35-4. 簡単な関数のPL/SQLからPL/pgSQLへの移植

以下はOracle PL/SQLの関数です。

CREATE OR REPLACE FUNCTION cs_fmt_browser_version(v_name IN varchar,
                                                  v_version IN varchar)
RETURN varchar IS
BEGIN
    IF v_version IS NULL THEN
        RETURN v_name;
    END IF;
    RETURN v_name || '/' || v_version;
END;
/
show errors;

この関数を通じて、PL/pgSQLとの違いを見てみましょう。

  • OracleINOUTINOUT というパラメータを関数に渡すことができます。 例えば、INOUTはパラメータが値を受け取って別の値を返すことを意味します。 PostgreSQL では "IN" パラメータしかないため、関数は単一の値しか返せません。 したがって、パラメータの種類指定はありません。

  • 関数プロトタイプ内の RETURN キーワード (関数本体ではありません) は PostgreSQL では RETURNS になります。 同様に ISAS になります。 PL/pgSQL 以外の言語でも関数を記述できるため、LANGUAGE 句が必要となります。

  • PostgreSQL は関数本体を文字列リテラルと考えます。 したがって、それを囲むドル引用符または他の引用符が必要です。 これは / で終了する Oracle の方法の代替です。

  • PostgreSQL には show errors コマンドはありません。 また、エラーが自動的に表示されるため、必要ありません。

それではPostgreSQLに移植されると、この関数がどのようになるか見てみましょう。

CREATE OR REPLACE FUNCTION cs_fmt_browser_version(v_name varchar,
                                                  v_version varchar)
RETURNS varchar AS $$
BEGIN
    IF v_version IS NULL THEN
        RETURN v_name;
    END IF;
    RETURN v_name || '/' || v_version;
END;
$$ LANGUAGE plpgsql;

例35-5は、他の関数を生成する関数を移植する方法、ならびに、その結果発生する引用符問題を扱う方法を示します。

例 35-5. 他の関数を生成するPL/SQLPL/pgSQLに移植

以下の手続きは、SELECT文からの行をとって、効率のためにIF文で結果を巨大な関数に埋め込んでいます。 特にカーソルとFORループにおける違いに注目してください。

以下はOracle版です。

CREATE OR REPLACE PROCEDURE cs_update_referrer_type_proc IS
    CURSOR referrer_keys IS 
        SELECT * FROM cs_referrer_keys 
        ORDER BY try_order;

    func_cmd VARCHAR(4000); 
BEGIN 
    func_cmd := 'CREATE OR REPLACE FUNCTION cs_find_referrer_type(v_host IN VARCHAR,
                 v_domain IN VARCHAR, v_url IN VARCHAR) RETURN VARCHAR IS BEGIN'; 

    FOR referrer_key IN referrer_keys LOOP 
        func_cmd := func_cmd ||
          ' IF v_' || referrer_key.kind
          || ' LIKE ''' || referrer_key.key_string
          || ''' THEN RETURN ''' || referrer_key.referrer_type
          || '''; END IF;'; 
    END LOOP; 

    func_cmd := func_cmd || ' RETURN NULL; END;'; 

    EXECUTE IMMEDIATE func_cmd; 
END; 
/ 
show errors;

この関数をPostgreSQLで記述するとこうなるでしょう。

CREATE OR REPLACE FUNCTION cs_update_referrer_type_proc() RETURNS void AS $func$
DECLARE
    referrer_keys RECORD;  -- FOR で使用される汎用レコードを宣言
    func_body text;
    func_cmd text;
BEGIN 
    func_body := 'BEGIN' ;

    -- FOR <record> 構文を使用した FOR ループで、問い合わせの結果
    -- をどのようにスキャンしているかに注意してください。

    FOR referrer_key IN SELECT * FROM cs_referrer_keys ORDER BY try_order LOOP
        func_body := func_body ||
          ' IF v_' || referrer_key.kind
          || ' LIKE ' || quote_literal(referrer_key.key_string)
          || ' THEN RETURN ' || quote_literal(referrer_key.referrer_type)
          || '; END IF;' ;
    END LOOP; 

    func_body := func_body || ' RETURN NULL; END;';

    func_cmd :=
      'CREATE OR REPLACE FUNCTION cs_find_referrer_type(v_host varchar,
                                                        v_domain varchar,
                                                        v_url varchar) 
        RETURNS varchar AS '
      || quote_literal(func_body)
      || ' LANGUAGE plpgsql;' ;

    EXECUTE func_cmd;
    RETURN;
END;
$func$ LANGUAGE plpgsql;

関数本体を別途作成し、それを quote_literal に渡して 本体内の引用符を二重化する方法に注目してください。 新規の関数を定義する時ドル引用符の使用が安全とは限らないため、この方法が必要となります。 それは referrer_key.key_string の領域に、どのような文字列が書き込まれているか不明だからです。 (referrer_key.kind は常に信用できる hostdomainurl であると仮定しますが、どんなものでも referrer_key.key_string になりうるので、ドル記号を含む可能性があります。) この関数は Oracle 版より実際に改善されています。 それは referrer_key.key_string または referrer_key.referrer_type が引用符を含むとき、おかしなコードを生成しないからです。

例35-6は、OUTパラメータを持ち、文字列操作を行なう関数の移植方法を示します。 PostgreSQLにはinstrはありませんが、他の関数を組み合わせることで回避できます。 項35.11.3に、移植を簡略化できるようにinstrPL/pgSQLによる実装を示します。

例 35-6. 文字列操作を行ない、OUTパラメータを持つPL/SQLプロシージャのPL/pgSQLへの移植

以下の Oracle PL/SQL プロシージャは、URLを解析していくつかの要素(ホスト、パス、問い合わせ)を返します。 PL/pgSQL 関数は 1つしか値を返すことができません。 PostgreSQL での回避方法 の1つとして、複合型 (行型) の戻り値を作成する方法があります。

以下はOracle版です。

CREATE OR REPLACE PROCEDURE cs_parse_url(
    v_url IN VARCHAR,
    v_host OUT VARCHAR,  -- この値は戻されます
    v_path OUT VARCHAR,  -- この値も戻されます
    v_query OUT VARCHAR) -- この値も戻されます
IS
    a_pos1 INTEGER;
    a_pos2 INTEGER;
BEGIN
    v_host := NULL;
    v_path := NULL;
    v_query := NULL;
    a_pos1 := instr(v_url, '//');

    IF a_pos1 = 0 THEN
        RETURN;
    END IF;
    a_pos2 := instr(v_url, '/', a_pos1 + 2);
    IF a_pos2 = 0 THEN
        v_host := substr(v_url, a_pos1 + 2);
        v_path := '/';
        RETURN;
    END IF;

    v_host := substr(v_url, a_pos1 + 2, a_pos2 - a_pos1 - 2);
    a_pos1 := instr(v_url, '?', a_pos2 + 1);

    IF a_pos1 = 0 THEN
        v_path := substr(v_url, a_pos2);
        RETURN;
    END IF;

    v_path := substr(v_url, a_pos2, a_pos1 - a_pos2);
    v_query := substr(v_url, a_pos1 + 1);
END;
/
show errors;

これを PostgreSQL で記述すると、以下のようになります。

CREATE TYPE cs_parse_url_result AS (
    v_host VARCHAR,
    v_path VARCHAR,
    v_query VARCHAR
);

CREATE OR REPLACE FUNCTION cs_parse_url(v_url VARCHAR)
RETURNS cs_parse_url_result AS $$
DECLARE
    res cs_parse_url_result;
    a_pos1 INTEGER;
    a_pos2 INTEGER;
BEGIN
    res.v_host := NULL;
    res.v_path := NULL;
    res.v_query := NULL;
    a_pos1 := instr(v_url, '//');

    IF a_pos1 = 0 THEN
        RETURN res;
    END IF;
    a_pos2 := instr(v_url, '/', a_pos1 + 2);
    IF a_pos2 = 0 THEN
        res.v_host := substr(v_url, a_pos1 + 2);
        res.v_path := '/';
        RETURN res;
    END IF;

    res.v_host := substr(v_url, a_pos1 + 2, a_pos2 - a_pos1 - 2);
    a_pos1 := instr(v_url, '?', a_pos2 + 1);

    IF a_pos1 = 0 THEN
        res.v_path := substr(v_url, a_pos2);
        RETURN res;
    END IF;

    res.v_path := substr(v_url, a_pos2, a_pos1 - a_pos2);
    res.v_query := substr(v_url, a_pos1 + 1);
    RETURN res;
END;
$$ LANGUAGE plpgsql;

この関数は以下のように使用できます。

SELECT * FROM cs_parse_url('http://foobar.com/query.cgi?baz');

例35-7は、Oracleに特化した多くの機能を使用したプロシージャの移植方法を示します。

例 35-7. PL/SQLプロシージャのPL/pgSQLへの移植

以下はOracle版です。

CREATE OR REPLACE PROCEDURE cs_create_job(v_job_id IN INTEGER) IS
    a_running_job_count INTEGER;
    PRAGMA AUTONOMOUS_TRANSACTION;(1)
BEGIN
    LOCK TABLE cs_jobs IN EXCLUSIVE MODE;(2)

    SELECT count(*) INTO a_running_job_count FROM cs_jobs WHERE end_stamp IS NULL;

    IF a_running_job_count > 0 THEN
        COMMIT; -- ロックを解放(3)
        raise_application_error(-20000, 'Unable to create a new job: a job is currently running.');
    END IF;

    DELETE FROM cs_active_job;
    INSERT INTO cs_active_job(job_id) VALUES (v_job_id);

    BEGIN
        INSERT INTO cs_jobs (job_id, start_stamp) VALUES (v_job_id, sysdate);
    EXCEPTION
		WHEN dup_val_on_index THEN NULL; -- 既存であっても問題なし
    END;
    COMMIT;
END;
/
show errors

このようなプロシージャは void 型を返す PostgreSQL 関数に簡単に変換することができます。 これは以下のような事を教えてくれることもあって、このプロシージャは特におもしろいです。

(1)
PostgreSQLにはPRAGMA文はありません。
(2)
PL/pgSQLLOCK TABLEを使用するならば、トランザクションの終了を呼び出すまでロックが解放されません。
(3)
PL/pgSQL 関数内部では、COMMIT を使用できません。 関数は外部のトランザクションの一部として実行されるため、COMMIT は関数の実行の終了を意味するからです。 しかし、LOCK TABLE によって掛けたロックはエラーが起こったとき開放されるので、この例題では特に必要ありません。

それでは、このプロシージャをPL/pgSQLに移植することができた方法を見てみましょう。

CREATE OR REPLACE FUNCTION cs_create_job(v_job_id integer) RETURNS void AS $$
DECLARE
    a_running_job_count integer;
BEGIN
    LOCK TABLE cs_jobs IN EXCLUSIVE MODE;

    SELECT count(*) INTO a_running_job_count FROM cs_jobs WHERE end_stamp IS NULL;

    IF a_running_job_count > 0 THEN
        RAISE EXCEPTION 'Unable to create a new job: a job is currently running';(1)
    END IF;

    DELETE FROM cs_active_job;
    INSERT INTO cs_active_job(job_id) VALUES (v_job_id);

    BEGIN
        INSERT INTO cs_jobs (job_id, start_stamp) VALUES (v_job_id, now());
    EXCEPTION
        WHEN unique_violation THEN (2)
			-- 既存であっても問題なし
    END;

    RETURN;
END;
$$ LANGUAGE plpgsql;

(1)
RAISE 構文は Oracle における同様の文とかなり異なります。
(2)
PL/pgSQL がサポートする例外の名称は、Oracle と異なります。 提供する例外の名称は、はるかに広範囲です (付録Aを見てください)。 今のところ、ユーザ定義の例外名称を宣言できません。
このプロシージャは Oracle 版に比べて機能的な違いがあります。 それは cs_jobs テーブルの排他的ロックがトランザクションの終了まで継続することです。 同様に、関数呼び出しの後で (例えばエラーが原因で) アボートすると、プロシージャの影響はロールバックされます。

35.11.2. その他の注意事項

本節では、Oracle PL/SQL関数のPostgreSQLへの移植における、その他の注意事項を説明します。

35.11.2.1. 例外後の暗黙的ロールバック

PL/pgSQL において EXCEPTION 句が例外を捕捉すると、BEGIN 以降のそのブロックにおけるデータベースの変更が自動的にロールバックされます。 すなわち、Oracle の PL/SQL による以下のプログラムと同等の処理が実行されます。

    BEGIN
        SAVEPOINT s1;
        ... code here ...
    EXCEPTION
        WHEN ... THEN
            ROLLBACK TO s1;
            ... code here ...
        WHEN ... THEN
            ROLLBACK TO s1;
            ... code here ...
    END;

このような方式で SAVEPOINTROLLBACK TO を使用した Oracle のプロシージャの書き換えは簡単です。 単に SAVEPOINTROLLBACK TO の処理を削除すればいいだけです。 これと異なった方式で SAVEPOINTROLLBACK TO を使用したプロシージャのときは、それに応じた工夫が必要になると思われます。

35.11.2.2. EXECUTE

PL/pgSQLEXECUTEPL/SQL版とよく似ています。 しかし項35.6.5で説明されているquote_literal(text)quote_string(text)を使うことを覚えておかなければいけません。 これらの関数を使用しない限りEXECUTE ''SELECT * from $1'';という構文は動作しません。

35.11.2.3. PL/pgSQL関数の最適化

PostgreSQL には実行を最適化するために 2つの関数生成修飾子があります。 一時性 (同じ引数が与えられた場合常に同じ結果が返します) と"厳密性" (引数のいずれかにNULLが含まれる場合NULLを返します) です。 詳細はCREATE FUNCTIONを参照してください。

これらの最適化属性を利用するためには、CREATE FUNCTION文を以下のようにします。

CREATE FUNCTION foo(...) RETURNS integer AS $$
...
$$ LANGUAGE plpgsql STRICT IMMUTABLE;

35.11.3. 付録

本節には、移植作業を簡略化するために使用できる、Oracle互換のinstr関数のコードがあります。

--
-- Oracle のものと同じ動作をする instr 関数
-- 構文 :instr(string1,string2,[n],[m]) ただし、[]は省略可能なパラメータ
-- 
-- string1 内の n番目の文字からm番目の文字までで string2 を探します。
-- n が負の場合、逆方向に検索します。 mが渡されなかった場合は、1 と 
-- みなします(最初の文字から検索を始めます)。
--

CREATE FUNCTION instr(varchar, varchar) RETURNS integer AS $$
DECLARE
    pos integer;
BEGIN
    pos:= instr($1, $2, 1);
    RETURN pos;
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;


CREATE FUNCTION instr(string varchar, string_to_search varchar, beg_index integer)
RETURNS integer AS $$
DECLARE
    pos integer NOT NULL DEFAULT 0;
    temp_str varchar;
    beg integer;
    length integer;
    ss_length integer;
BEGIN
    IF beg_index > 0 THEN
        temp_str := substring(string FROM beg_index);
        pos := position(string_to_search IN temp_str);

        IF pos = 0 THEN
            RETURN 0;
        ELSE
            RETURN pos + beg_index - 1;
        END IF;
    ELSE
        ss_length := char_length(string_to_search);
        length := char_length(string);
        beg := length + beg_index - ss_length + 2;

        WHILE beg > 0 LOOP
            temp_str := substring(string FROM beg FOR ss_length);
            pos := position(string_to_search IN temp_str);

            IF pos > 0 THEN
                RETURN beg;
            END IF;

            beg := beg - 1;
        END LOOP;

        RETURN 0;
    END IF;
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;


CREATE FUNCTION instr(string varchar, string_to_search varchar,
                      beg_index integer, occur_index integer)
RETURNS integer AS $$
DECLARE
    pos integer NOT NULL DEFAULT 0;
    occur_number integer NOT NULL DEFAULT 0;
    temp_str varchar;
    beg integer;
    i integer;
    length integer;
    ss_length integer;
BEGIN
    IF beg_index > 0 THEN
        beg := beg_index;
        temp_str := substring(string FROM beg_index);

        FOR i IN 1..occur_index LOOP
            pos := position(string_to_search IN temp_str);

            IF i = 1 THEN
                beg := beg + pos - 1;
            ELSE
                beg := beg + pos;
            END IF;

            temp_str := substring(string FROM beg + 1);
        END LOOP;

        IF pos = 0 THEN
            RETURN 0;
        ELSE
            RETURN beg;
        END IF;
    ELSE
        ss_length := char_length(string_to_search);
        length := char_length(string);
        beg := length + beg_index - ss_length + 2;

        WHILE beg > 0 LOOP
            temp_str := substring(string FROM beg FOR ss_length);
            pos := position(string_to_search IN temp_str);

            IF pos > 0 THEN
                occur_number := occur_number + 1;

                IF occur_number = occur_index THEN
                    RETURN beg;
                END IF;
            END IF;

            beg := beg - 1;
        END LOOP;

        RETURN 0;
    END IF;
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;