36.11. 从Oracle的 PL/SQL 移植

本节解释了OraclePL/SQLPostgreSQLPL/pgSQL语言之间的差别, 希望能对那些从Oracle®向PostgreSQL移植应用的人有所帮助。

PL/pgSQL与 PL/SQL 在许多方面都非常类似。 它是一种块结构的,祈使语气(命令性)的语言并且必须声明所有变量。 赋值,循环,条件等都很类似。 在从OraclePostgreSQL移植的时候必须记住一些事情:

36.11.1. 移植样例

Example 36-5 演示了如何从 PL/SQLPL/pgSQL 移植一个简单的函数。

Example 36-5. 从 PL/SQLPL/pgSQL 移植一个简单的函数

下面是一个Oracle PL/SQL函数:

CREATE OR REPLACE FUNCTION cs_fmt_browser_version(v_name varchar,
						 v_version 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与之的不同:

  • 在函数原型里的 RETURN (不是函数体里的)关键字到了 PostgreSQL 里就是 RETURNS。还有,IS 变成 AS, 并且你还需要增加一个 LANGUAGE 子句,因为 PL/pgSQL 并非唯一可用的函数语言。

  • 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;

Example 36-6 演示了如何移植一个创建另外一个函数的函数的方法,以及演示了如何处理引号逃逸的问题。

Example 36-6. 从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 :='';
    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_key RECORD;  -- 声明一个在 FOR 里用的通用的记录
    func_body text;
    func_cmd text;
BEGIN 
    func_body := 'BEGIN';
    -- 请注意我们是如何在一个 FOR 循环中使用 FOR <record> 构造
    -- 扫描各条结果的
    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 :=''
      || quote_literal(func_body)
      || ' LANGUAGE plpgsql;' ;
    EXECUTE func_cmd;
END;
$func$ LANGUAGE plpgsql;

请注意函数体是如何独立制作并且传递给 quote_literal,对其中的单引号复制双份的。 我们需要这个技巧是因为我们无法使用美元符包围定义新函数:我们没法保证 referrer_key.key_string 字段过来的字串会解析成什么样子。(我们可以假设 referrer_key.kind 可以是只有 hostdomain,或者 url,但是 referrer_key.key_string 可能是任何东西, 特别是它可能包含美元符。)这个函数实际上是对原来 Oracle 版本的一个改进, 因为如果在 referrer_key.key_string 或者 referrer_key.referrer_type 包含单引号的时候, 它不会生成有毛病的代码。

Example 36-7 演示了如何移植一个带有 OUT 参数和字串处理的函数。PostgreSQL 里面没有内置 instr 函数,但是你可以用其它函数的组合来绕开它。 在 Section 36.11.3 里有一个 PL/pgSQLinstr 实现, 你可以用它让你的移植变得更简单些。

Example 36-7. 从 PL/SQLPL/pgSQL 移植一个字串操作和OUT参数的过程

下面的OraclePL/SQL 过程用于分析一个 URL 并且返回若干个元素 (主机,路径和命令)。

下面是 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;

下面就是把这个过程翻译成 PL/pgSQL 可能的样子:

CREATE OR REPLACE FUNCTION cs_parse_url(
    v_url IN VARCHAR,
    v_host OUT VARCHAR,  -- 这个将被传回
    v_path OUT VARCHAR,  -- 这个也传回
    v_query OUT VARCHAR) -- 还有这个
AS $$
DECLARE
    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;
$$ LANGUAGE plpgsql;

这个函数可以这么用:

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

Example 36-8 演示了如何一个使用各种 Oracle 特有的特性的过程。

Example 36-8. 从 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; -- 如果已经存在,别担心
    END;
    COMMIT;
END;
/
show errors

象这样的过程可以很容易用返回 void 的函数移植到PostgreSQL里。 我们对这个过程特别感兴趣是因为它可以教我们一些东西:

(1)
PostgreSQL里没有 PRAGMA 语句。
(2)
如果你在PL/pgSQL里做一个 LOCK TABLE, 那么这个锁在调用该命令的事务完成之前将不会释放。
(3)
你不能在 PL/pgSQL 函数里发出 COMMIT。 函数是在外层的事务里运行的,因此 COMMIT 蕴涵着结束函数的执行。 不过,在这个特殊场合下,这是不必要的了,因为 LOCK TABLE 获取的锁将在我们抛出错误的时候释放。
(2)
EXCEPTION WHEN 不得不用一个 IF 语句替代.

下面是我们把这个过程移植到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)
            -- don't worry if it already exists
    END;
END;
$$ LANGUAGE plpgsql;

(1)
RAISE 的语法和 Oracle 的类似语句差别相当明显。
(2)
PL/pgSQL 里支持的例外的名字和 Oracle 的不同。 PL/pgSQL 内置的例外名要大的多(参阅 Appendix A)。 目前还不能声明用户定义的例外名。
整个过程和 Oracle 的等效的主要的功能型差别是,在 cs_jobs 上持有的排他锁将保持到调用的事务结束。 同样,如果调用者后来退出(比如说因为错误),这个过程的效果将被回滚掉。

36.11.2. 其它要注意的东西

本节解释几个从 Oracle PL/SQL 函数向 PostgreSQL 移植的几个其它方面的事情。

36.11.2.1. 例外后的隐含回滚

PL/pgSQL 里,如果一个例外被 EXCEPTION 子句捕获, 那么所有自这个块的 BEGIN 以来的u乐平台登录注册库改变都会被自动回滚。 也就是说,这个行为等于你在 Oracle 里的

    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,那么就需要想想了。

36.11.2.2. EXECUTE

PostgreSQL版本的 EXECUTE 运转得类似 PL/SQL 的, 不果你必须记住要象 Section 36.6.4 里描述的那样用 quote_literalquote_string。 如果你不用这些函数,那么象 EXECUTE 'SELECT * FROM $1'; 这样的构造是不会运转的。

36.11.2.3. 优化PL/pgSQL函数

PostgreSQL给你两个创建函数的修饰词用来优化执行: "volatility(易变的)"(在给出的参数相同时, 函数总是返回相同结果)和 strictness(严格的)(如果任何参数是 NULL,那么函数返回 NULL)。 参考 CREATE FUNCTION 的手册获取细节。

如果要使用这些优化属性,那么你的 CREATE FUNCTION 语句可能看起来像这样:

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

36.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 STRICT IMMUTABLE;

CREATE FUNCTION instr(string varchar, string_to_search varchar, beg_index integer)
RETURNS integer AS $$
    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
    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  STRICT IMMUTABLE;