37.11. 从 Oracle PL/SQL 移植 #
本节解释 PostgreSQL 的 PL/pgSQL 语言与 Oracle 的 PL/SQL 语言之间的差异,以帮助把应用程序从 Oracle 移植到 PostgreSQL 的开发者。
PL/pgSQL 在许多方面与 PL/SQL 相似。它是一种块结构的命令式语言,所有变量都必须声明。赋值、循环、条件都相似。从 PL/SQL 移植到 PL/pgSQL 时要记住的主要差异是:
PostgreSQL 中参数没有默认值。
在 PostgreSQL 中可以重载函数名。这常被用来绕开缺少默认参数的问题。
PL/pgSQL 中不需要游标,把查询放进
FOR语句即可。(见例 37.3。)在 PostgreSQL 中,需要转义函数体中的单引号。见第 37.2.1 节。
不要用包(package),改用模式(schema)来把函数组织成组。
37.11.1. 移植示例
例 37.2展示如何把一个简单函数从 PL/SQL 移植到 PL/pgSQL。
例 37.2. 把简单函数从 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 的差异:
PostgreSQL 没有命名参数。你必须在函数内部显式地为它们建立别名。
Oracle 的函数可以有
IN、OUT和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;
例 37.3展示如何移植一个创建另一个函数的函数,以及如何处理随之而来的引号问题。
例 37.3. 把创建另一函数的函数从 PL/SQL 移植到 PL/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; -- Declare a generic record to be used in a 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 '';
-- Notice how we scan through the results of a query in a FOR loop
-- using the FOR <record> construct.
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 will work because we are not substituting any variables.
-- Otherwise it would fail. Look at PERFORM for another way to run functions.
EXECUTE a_output;
END;
' LANGUAGE plpgsql;
例 37.4展示如何移植一个带
OUT 参数和字符串处理的过程。PostgreSQL 没有 instr 函数,但可以用其他函数组合来绕过。第 37.11.3 节中有一个
PL/pgSQL 实现的 instr,可以用来简化你的移植工作。
例 37.4. 把带字符串处理和 OUT 参数的过程从
PL/SQL 移植到 PL/pgSQL
下面的 Oracle PL/SQL 过程用于解析 URL 并返回若干元素(主机、路径和查询)。 PL/pgSQL 函数只能返回一个值。在 PostgreSQL 中,绕过这个问题的一种办法是把过程拆成三个不同的函数:一个返回主机,一个返回路径,一个返回查询。
这是 Oracle 版本:
CREATE OR REPLACE PROCEDURE cs_parse_url(
v_url IN VARCHAR,
v_host OUT VARCHAR, -- This will be passed back
v_path OUT VARCHAR, -- This one too
v_query OUT VARCHAR) -- And this one
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_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 ''''; -- Return a blank
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;
例 37.5展示如何移植一个使用许多 Oracle 特有特性的过程。
例 37.5. 把过程从 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; -- 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 函数。这个过程特别有意思,因为它能教给我们一些东西:
PostgreSQL 中没有 | |
如果你在 PL/pgSQL 中执行
| |
PL/pgSQL 函数中也不能有事务。整个函数(以及其中调用的其他函数)在一个事务中执行,如果出了问题,PostgreSQL 会回滚该事务。 | |
exception when 需要换成 |
下面是我们把这个过程移植到 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
-- This job is not in the table so lets insert it.
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;
注意你可以在 PL/pgSQL 中引发通知(或错误)。 |
37.11.2. 其他需要注意的事项 #
本节说明把 Oracle PL/SQL 函数移植到 PostgreSQL 时还有一些要注意的事项。
37.11.2.1. EXECUTE
PL/pgSQL 版的 EXECUTE 与
PL/SQL 版工作方式类似,但必须记得按第 37.6.4 节所述使用
quote_literal(text) 和
quote_string(text)。EXECUTE ''SELECT * FROM $1''; 这类构造除非使用这些函数,否则不会工作。
37.11.2.2. 优化 PL/pgSQL 函数 #
PostgreSQL 提供两个函数创建修饰符用于优化执行:易变性(函数在给定相同参数时是否总是返回相同结果)和“严格性”(函数在有参数为空时是否返回空)。细节请查阅
CREATE FUNCTION 的描述。
要利用这些优化属性,你的 CREATE FUNCTION 语句可以是下面这个样子:
CREATE FUNCTION foo(...) RETURNS integer AS ' ... ' LANGUAGE plpgsql STRICT IMMUTABLE;
37.11.3. 附录 #
本节包含一个 Oracle 兼容的 instr 函数的代码,你可以用它来简化移植工作。
--
-- instr functions that mimic Oracle's counterpart
-- Syntax: instr(string1, string2, [n], [m]) where [] denotes optional parameters.
--
-- 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).
--
CREATE FUNCTION instr(varchar, varchar) RETURNS integer AS '
DECLARE
pos integer;
BEGIN
pos:= instr($1, $2, 1);
RETURN pos;
END;
' LANGUAGE plpgsql;
CREATE FUNCTION instr(varchar, varchar, varchar) 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 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;