37.11. 從Oracle的 PL/SQL 移植

本節解釋了Oracle的 PL/SQL 和PostgreSQLPL/pgSQL語言之間的差別, 希望能對那些從OraclePostgreSQL移植應用的人有所幫助。

PL/pgSQL與 PL/SQL 在許多方面都非常類似。 它是一種塊結構的,祈使語氣(命令性)的語言並且必須聲明所有變量。 賦值,循環,條件等都很類似。 在從OraclePostgreSQL移植的時候必須記住一些事情:

37.11.1. 移植樣例

Example 37-2 演示了如何從 PL/SQLPL/pgSQL 移植一個簡單的函數。

Example 37-2. 從 PL/SQLPL/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與之的不同:

  • PostgreSQL 沒有命名的參數。 你必須在自己的函數中明確地給它們取個別名。

  • Oracle可以有 INOUT, 和 INOUT 參數傳遞給函數。比如, INOUT 的意思是該參數將接受一個數值並且返回另外一個。 PostgreSQL只有 "IN" 參數。

  • 在函數原型裡的 RETURN (不是函數體裡的)關鍵字到了 PostgreSQL 裡就是 RETURNS

  • PostgreSQL裡,函數是使用單引號做為分隔符創建的, 因此你必須在你的函數體裡逃逸單引號。

  • PostgreSQL裡沒有 /show errors 命令。

下面是這個函數移植到PostgreSQL之後的樣子:

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

Example 37-3 演示了如何移植一個創建另外一個函數的函數的方法,以及演示了如何處理逃逸引號的問題。

Example 37-3. 從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;

    a_output varchar(4000); 
BEGIN 
    a_output := '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 
        a_output := a_output || ' IF v_' || referrer_key.kind || ' LIKE ''' || 
referrer_key.key_string || ''' THEN RETURN ''' || referrer_key.referrer_type || 
'''; END IF;'; 
    END loop; 

    a_output := a_output || ' RETURN NULL; END;'; 
    EXECUTE IMMEDIATE a_output; 
END; 
/ 
show errors;

下面是這個函數在 PostgreSQL 裡面的樣子:

CREATE FUNCTION cs_update_referrer_type_proc() RETURNS integer AS '
DECLARE
    referrer_keys RECORD;  -- 聲明一個在 FOR 裡用的通用的記錄
    a_output varchar(4000);
BEGIN 
    a_output := ''CREATE FUNCTION cs_find_referrer_type(varchar,varchar,varchar) 
                  RETURNS varchar AS '''' 
                     DECLARE 
                         v_host ALIAS FOR $1; 
                         v_domain ALIAS FOR $2; 
                         v_url ALIAS FOR $3;
		     BEGIN ''; 

    -- 請注意我們是如何在一個 FOR 循環中使用 FOR <record> 構造
    -- 掃描各條結果的

    FOR referrer_keys IN SELECT * FROM cs_referrer_keys ORDER BY try_order LOOP
        a_output := a_output || '' IF v_'' || referrer_keys.kind || '' LIKE '''''''''' 
                 || referrer_keys.key_string || '''''''''' THEN RETURN '''''' 
                 || referrer_keys.referrer_type || ''''''; END IF;''; 
    END LOOP; 
  
    a_output := a_output || '' RETURN NULL; END; '''' LANGUAGE plpgsql;''; 
 
    -- 這樣是可以 EXECUTE 的原因是因為我們沒有代換任何變量
    -- 否則它可就不能玩了。請查閱 PERFORM 獲取另外一種運行函數的方法
    
    EXECUTE a_output; 
END; 
' LANGUAGE plpgsql;

Example 37-4 演示了如何移植一個帶有 OUT 參數和字串處理的函數。PostgreSQL 裡面沒有 instr 函數,但是你可以用其它函數的組合來繞開它。 在 Section 37.11.3 裡有一個 PL/pgSQLinstr 實現, 你可以用它讓你的移植變得更簡單些。

Example 37-4. 從 PL/SQLPL/pgSQL 移植一個字串操作和OUT參數的過程

下面的OraclePL/SQL 過程用于分析一個 URL 並且返回若幹個元素 (主機,路徑和命令)。PL/pgSQL函數只能返回一個數值。 在 PostgreSQL裡,一個繞開這個局限的方法就是把過程分裂成三個不同的函數: 一個返回主機,另外一個返回路徑,最後一個返回命令。

下面是 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 OR REPLACE FUNCTION cs_parse_url_host(varchar) RETURNS varchar AS ' 
DECLARE 
    v_url ALIAS FOR $1; 
    v_host varchar; 
    v_path varchar; 
    a_pos1 integer; 
    a_pos2 integer; 
    a_pos3 integer; 
BEGIN 
    v_host := 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 v_host; 
    END IF; 

    v_host := substr(v_url, a_pos1 + 2, a_pos2 - a_pos1 - 2 ); 
    RETURN v_host; 
END; 
' LANGUAGE plpgsql;

Example 37-5 演示了如何一個使用各種 Oracle 特有的特性的過程。

Example 37-5. 從 PL/SQLPL/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; -- free lock(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; -- don't worry IF it already exists(4)
    END;
    COMMIT;
END;
/
show errors

象這樣的過程可以很容易用返回 integer 的 函數移植到PostgreSQL裡.我們對這個過程特別感興趣是因為它可以教我們一些東西:

(1)
PostgreSQL裡沒有 PRAGMA 語句。
(2)
如果你在PL/pgSQL裡做一個 LOCK TABLE, 那麼這個鎖在調用該命令的事務完成之前將不會釋放。
(3)
你也不能在PL/pgSQL過程裡使用事務。 整個函數(以及其它從那裡面調用的函數)都是在一個事務裡執行的並且如果出錯了,那麼 PostgreSQL將回滾結果。
(4)
EXCEPTION WHEN 不得不用一個 IF 語句替代.

下面是我們把這個過程移植到PL/pgSQL裡的一種方法:

CREATE OR REPLACE FUNCTION cs_create_job(integer) RETURNS integer AS '
DECLARE
    v_job_id aliAS for $1;
    a_running_job_count integer;
    a_num 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.'';
    END IF;

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

    SELECT count(*) INTO a_num FROM cs_jobs WHERE job_id=v_job_id;
    IF NOT FOUND THEN  -- If nothing wAS RETURNed in the last query
        -- 該作業不在該表中,因此讓我們把它插入
        INSERT INTO cs_jobs(job_id, start_stamp) values(v_job_id, current_timestamp);
        RETURN 1;
    ELSE
        RAISE NOTICE ''Job already running.'';(1)
    END IF;

    RETURN 0;
END;
' LANGUAGE plpgsql;

(1)
請注意你在PL/pgSQL 裡拋出注意信息(或者錯誤)的方法。

37.11.2. 其它要注意的東西

本節解釋幾個從 Oracle PL/SQL 函數向 PostgreSQL 移植的幾個其它方面的事情。

37.11.2.1. EXECUTE

PostgreSQL版本的 EXECUTE 運轉得類似 PL/SQL 的, 不果你必須記住要象 Section 37.6.4 裡描述的那樣用 quote_literal(text)quote_string(text)。 如果你不用這些函數,那麼象 EXECUTE ''SELECT * FROM $1''; 這樣的構造是不會運轉的。

37.11.2.2. 優化PL/pgSQL函數

PostgreSQL給你兩個創建函數的修飾詞用來優化執行: "易變的"(在給出的參數相同時, 函數總是返回相同結果)和 嚴格的(如果任何參數是 NULL,那麼函數返回 NULL)。 參考 CREATE FUNCTION 的手冊獲取細節。

如果要使用這些優化屬性,那麼你的 CREATE FUNCTION 語句可能看起來像這樣:

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

37.11.3. 附錄

本節包含 Oracle-兼容的 instr,你可以用它簡化你的移植過程。

--
-- 模擬 Oracle 概念的 instr 函數
-- 語法: instr(string1,string2,[n],[m]) 這裡的 [] 表示可選參數
-- 
-- 從 string1 的第 n 個字符開始尋找 string2 的第 m 個出現。
-- 如果 n 是負數,則從後向前著。如果沒有傳遞 m,假定胃 1(從第一個字符開始找)。
-- 
--

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


CREATE OR REPLACE FUNCTION instr(varchar, varchar, integer) RETURNS integer AS '
DECLARE
    string ALIAS FOR $1;
    string_to_search ALIAS FOR $2;
    beg_index ALIAS FOR $3;
    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;

CREATE OR REPLACE FUNCTION instr(varchar,varchar,integer,integer) RETURNS integer AS '
DECLARE
    string ALIAS FOR $1;
    string_to_search ALIAS FOR $2;
    beg_index ALIAS FOR $3;
    occur_index ALIAS FOR $4;
    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;