24.5. 从 Oracle 的 PL/SQL 向 PL/pgSQL移植

作者: Roberto Mello ()

本节解释了 Oracle 的 PL/SQL 和 PostgreSQL 的 PL/pgSQL 语言 之间的差别,希望能对那些从 Oracle 向 PostgreSQL 移植应用的 人有所帮助.这里的大部分代码都来自 ArsDigita Clickstream module,这些东西都是我在 2000 年夏天和 OpenForce Inc. 合作向 PostgreSQL 移植时搞的.

PL/pgSQL 与 PL/SQL 在许多方面都非常类似.它是一种块结构的, 祈使语气(命令性)的语言(必须声明所有变量).PL/SQL 比 PostgreSQL 的 PL/pgSQL 有更多的特性,但是 PL/pgSQL 里面允许使用 PL/SQL 所具有 的大部分功能并且还在稳步前进.

24.5.1. 主要的区别

在从 Oracle 向 PostgreSQL 移植的时候必须记住一些事情∶

24.5.1.1. 给我加引号∶逃逸单引号

在 PostgreSQL 里,你需要在自给的函数定义里逃逸单引号. 有时候这么做会产生相当有趣的代码,尤其是如果你所创建的 函数是生成其它函数的函数,如我们在 Example 24-6. 里所说的那样,逃逸大量单引号要注意的一件事是∶ 除了开始/结尾的引号之外,所有其它的都是偶数数目的.

Table 24-1 给出了这个范围.( 你会很喜欢这个小小的表格的.)

Table 24-1. 单引号逃逸表

引号的数目用法例子结果
1用于开始/结束函数体
CREATE FUNCTION foo() RETURNS INTEGER AS '...'
LANGUAGE 'plpgsql';
如例所示
2用于赋值 SELECT 中,用于分隔字串等
a_output := ''Blah'';
SELECT * FROM users WHERE f_name=''foobar'';
SELECT * FROM users WHERE f_name='foobar';
4 在你需要在结果字串中出现两个单引号,但又不中止该字串的时候.
a_output := a_output || '' AND name 
    LIKE ''''foobar'''' AND ...''
AND name LIKE 'foobar' AND ...
6 在你需要在结果字串中出现两个单引号,而且 终止该字串的时候.
a_output := a_output || '' AND name 
    LIKE ''''foobar''''''
AND name LIKE 'foobar'
10 如果你需要在结果字串中出现两个单引号(这里需要 8 个引号) 而且终止改字串(再加两个). 你可能只有在用函数生成其它函数的时候才需要这个东西( 比如 Example 24-6 ).
a_output := a_output || '' if v_'' || 
    referrer_keys.kind || '' like '''''''''' 
    || referrer_keys.key_string || '''''''''' 
    then return ''''''  || referrer_keys.referrer_type 
    || ''''''; end if;''; 
if v_<...> like ''<...>'' then return ''<...>''; end if;

24.5.2. 移植函数

Example 24-5. 一个简单的函数

下面是一个 Oracle 函数∶

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 与之的不同∶

  • 不允许 OR REPLACE 子句.你必须在创建函数之前 明确地删除它才能获得类似的行为.

  • PostgreSQL 没有命名的参数. 你必须在自己的函数中明确地给它们取个别名.

  • Oracle 可以有 INOUT, 和 INOUT 参数传递给函数.比如, INOUT 的意思是该参数将接受一个数值并且返回 另外一个.PostgreSQL 只有 “IN” 参数并且函数只能 返回一个数值.

  • 在函数原型里的 RETURN(不是函数体里的) 关键字到了 PostgreSQL 里就是RETURNS

  • 在 PostgreSQL 里,函数是使用单引号做为分隔符创建的, 因此你必须在你的函数里逃逸单引号(有时候会相当麻烦;参阅 Section 24.5.1.1).

  • 在 PostgreSQL 里没有 /show errors 命令.

现在让我们看看移植到 PostgreSQL 之后这个函数是什么样子∶

DROP FUNCTION cs_fmt_browser_version(varchar, varchar);
CREATE FUNCTION cs_fmt_browser_version(varchar, varchar)
RETRUNS 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 24-6. 一个创建其它函数的函数

下面的过程从一个 SELECT 语句中抓取 若干行,然后为了提高效率,又用 IF 语句中的 结果制作了一个巨大的函数. 请特别注意在 PostgreSQL 里游标,FOR 循环和需要逃逸的 单引号的区别.

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

    -- 
    -- 请注意我们是如何在一个 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'''';''; 
 
    -- 这样是可以运行的原因是因为我们没有代换任何变量
    -- 否则它可就不能玩了.请查阅 PERFORM 获取另外一种运行函数的方法
    
    EXECUTE a_output; 
end; 
' LANGUAGE 'plpgsql';

Example 24-7. 一个有许多字串操作和 OUT 参数的过程

下面的 Oracle PL/SQL 过程用于分析一个 URL 并且返回若干个元素 (主机,路径和查询).它是一个过程是因为在 PL/pgSQL 函数里, 只有一个函数可以返回(参阅 Section 24.5.3).在 PostgreSQL 里, 一个绕开这个局限的方法就是把过程分裂成三个不同的函数∶ 一个返回主机,另外一个返回路径,最后一个返回查询.

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, '//'); -- PostgreSQL 没有 instr 函数

    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 的样子∶

drop function cs_parse_url_host(varchar); 
create 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';

注意: PostgreSQL 没有 instr 函数, 因此你可以用其它函数的组合来绕开这个局限.我自己 觉得干这件事太累,所以就创建了我自己的 instr, 它的行为和 Oracle 的完全一样(可以让我的生活更轻松一些). 参阅 Section 24.5.6 获取代码.

24.5.3. 过程

Oracle 的过程给开发人员的灵活性更多一些,因为它不需要明确返回 任何东西,但是它可以通过使用 INOUT 和 OUT 参数来返回数据.

例子∶

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 将回滚结果.因此只允许一个 BEGIN 语句.
(4)
exception when 不得不用一个 IF 语句替代.

因此让我们看看我们把这个过程移植到 PL/pgSQL 里的一种方法∶

drop function cs_create_job(integer);
create function cs_create_job(integer) returns integer as ' declare
    v_job_id alias for $1;
    a_running_job_count integer;
    a_num integer;
    -- pragma autonomous_transaction;
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
        -- commit; -- free lock
        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, sysdate());
        return 1;
    ELSE
        raise NOTICE ''Job already running.'';(1)
    END IF;

    return 0;
end;
' language 'plpgsql';
(1)
请注意你在 PL/pgSQL 里抛出注意信息(或者错误)的方法.

24.5.4. 包

注意: 我自己也没怎么用过包,所以如果这里有错误,请告诉我.

包是 Oracle 给我们提供的将 PL/SQL 语句和函数都封装到一个实体 (象 Java 的类)里的方法,你可以在那里定义方法和对象.你可以用 一个 “.” (点)来访问这些对象/方法. 下面是一个来自 ACS4( ArsDigita 社区系统) 的 Oracle 包的例子∶

create or replace package body acs
as
  function add_user (
    user_id     in users.user_id%TYPE default null,
    object_type     in acs_objects.object_type%TYPE
               default 'user',
    creation_date   in acs_objects.creation_date%TYPE
               default sysdate,
    creation_user   in acs_objects.creation_user%TYPE
               default null,
    creation_ip     in acs_objects.creation_ip%TYPE default null,
  ...
  ) return users.user_id%TYPE
  is
    v_user_id       users.user_id%TYPE;
    v_rel_id        membership_rels.rel_id%TYPE;
  begin
    v_user_id := acs_user.new (user_id, object_type, creation_date,
                creation_user, creation_ip, email,
    ...
    return v_user_id;
  end;
end acs;
/
show errors

我们通过一种标准的命名规则为不同的 Oracle 包对象创建不同函数 的方法来把这个函数移植到 PostgreSQL 里.我们必须注意其它的一些 细节,比如在 PostgreSQL 函数里缺少缺省参数等.上面的包可能会 变得象下面这样∶

CREATE FUNCTION acs__add_user(integer,integer,varchar,datetime,integer,integer,...)
RETURNS integer AS '
DECLARE
    user_id ALIAS FOR $1;
    object_type ALIAS FOR $2;
    creation_date ALIAS FOR $3;
    creation_user ALIAS FOR $4;
    creation_ip ALIAS FOR $5;
    ...
    v_user_id users.user_id%TYPE;
    v_rel_id membership_rels.rel_id%TYPE;
BEGIN
    v_user_id := acs_user__new(user_id,object_type,creation_date,creation_user,creation_ip, ...);
    ...

    return v_user_id;
END;
' LANGUAGE 'plpgsql';

24.5.5. 其它要注意的东西

24.5.5.1. EXECUTE

PostgreSQL 版本的 EXECUTE 运转的很好, 不果你必须记住要象 Section 24.2.5.3 里描述的那样 用 quote_literal(TEXT)quote_string(TEXT). 如果你不用这些函数,那么象 EXECUTE ''SELECT * from $1''; 这样的构造是不会运转的.

24.5.5.2. 优化 PL/pgSQL 函数

PostgreSQL 给你两个函数创建的修饰词用来优化执行∶ iscachable (在给出的参数相通时, 函数总是返回相通结果)和 isstrict ( 如果任何参数是 NULL,那么函数返回 NULL). 参考 CREATE FUNCTION 的手册获取细节.

如果要使用这些优化属性,那么你必须在你的 CREATE FUNCTION 语句中使用 WITH 修饰词. 象这样∶

CREATE FUNCTION foo(...) RETURNS integer AS '
...
' LANGUAGE 'plpgsql'
WITH (isstrict, iscachable);

24.5.6. 附录

24.5.6.1. 我的 instr 函数的代码

--
-- instr functions that mimic Oracle's counterpart
-- Syntax: instr(string1,string2,[n],[m]) where [] denotes optional params.
-- 
-- Searches string1 beginning at the nth character for the mth
-- occurrence of string2. If n is negative, search backwards. If m is
-- not passed, assume 1 (search starts at first character).
--
-- by Roberto Mello ([email protected])
-- modified by Robert Gaszewski ([email protected])
-- Licensed under the GPL v2 or later.
--

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


DROP FUNCTION instr(varchar,varchar,integer);
CREATE 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';

--
-- Written by Robert Gaszewski ([email protected])
-- Licensed under the GPL v2 or later.
--
DROP FUNCTION instr(varchar,varchar,integer,integer);
CREATE 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';