本节解释 PostgreSQL 的 PL/pgSQL 语言与 Oracle 的 PL/SQL 语言之间的区别,以帮助将应用程序从 Oracle® 移植到 PostgreSQL 的开发人员。
PL/pgSQL 在许多方面与 PL/SQL 相似。它是一种块结构化的命令式语言,所有变量都必须声明。赋值、循环和条件判断是相似的。将 PL/SQL 移植到 PL/pgSQL 时,您应该注意的主要区别是:
如果在 SQL 命令中使用的名称既可以是命令中使用的表的列名,也可以是对函数变量的引用,那么 PL/SQL 会将其视为列名。默认情况下,PL/pgSQL 会抛出一个错误,抱怨该名称含糊不清。您可以将 plpgsql.variable_conflict 设置为 use_column,以使行为与 PL/SQL 匹配,如 第 41.11.1 节中所述。通常最好首先避免这种模糊性,但如果您必须移植大量依赖于此行为的代码,则设置 variable_conflict 可能是最佳解决方案。
在 PostgreSQL 中,函数体必须写成字符串文字。因此,您需要在函数体中使用美元引用或转义单引号。(请参阅 第 41.12.1 节。)
数据类型名称通常需要翻译。例如,在 Oracle 中,字符串值通常声明为 varchar2 类型,这是一个非 SQL 标准类型。在 PostgreSQL 中,改用 varchar 或 text 类型。类似地,将 number 类型替换为 numeric,或者如果存在更合适的类型,则使用其他数值数据类型。
使用模式(schemas)而不是包(packages)来组织函数分组。
由于没有包,也没有包级别的变量。这有点令人头疼。您可以使用临时表来保持每个会话的状态。
带有 REVERSE 的整数 FOR 循环的工作方式不同:PL/SQL 从第二个数字计数到第一个,而 PL/pgSQL 从第一个数字计数到第二个,在移植时需要交换循环边界。这种不兼容性是令人遗憾的,但不太可能改变。(请参阅 第 41.6.5.5 节。)
查询(非游标)的 FOR 循环的工作方式也不同:目标变量必须已声明,而 PL/SQL 始终隐式声明它们。这样做的好处是,变量值在循环退出后仍然可以访问。
使用游标变量时,存在各种符号差异。
示例 41.9 显示了如何将一个简单的函数从 PL/SQL 移植到 PL/pgSQL。
示例 41.9. 将一个简单的函数从 PL/SQL 移植到 PL/pgSQL
这是一个 Oracle PL/SQL 函数
CREATE OR REPLACE FUNCTION cs_fmt_browser_version(v_name varchar2,
v_version varchar2)
RETURN varchar2 IS
BEGIN
IF v_version IS NULL THEN
RETURN v_name;
END IF;
RETURN v_name || '/' || v_version;
END;
/
show errors;
让我们回顾一下这个函数,看看与 PL/pgSQL 相比有什么区别
varchar2 类型名称必须更改为 varchar 或 text。在本节的示例中,我们将使用 varchar,但如果您不需要特定的字符串长度限制,text 通常是更好的选择。
函数原型(而不是函数体)中的 RETURN 关键字在 PostgreSQL 中变为 RETURNS。此外,IS 变为 AS,您需要添加 LANGUAGE 子句,因为 PL/pgSQL 不是唯一可能的函数语言。
在 PostgreSQL 中,函数体被视为字符串文字,因此您需要围绕它使用引号或美元引用。这取代了 Oracle 方法中的结束符 /。
show errors 命令在 PostgreSQL 中不存在,而且由于错误会自动报告,因此不需要它。
这个函数移植到 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;
示例 41.10 展示了如何移植一个创建另一个函数的函数,以及如何处理由此产生的引用问题。
示例 41.10. 将创建另一个函数的函数从 PL/SQL 移植到 PL/pgSQL
下面的存储过程从 SELECT 语句中获取行,并构建一个包含 IF 语句结果的大型函数,以提高效率。
这是 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 VARCHAR2,
v_domain IN VARCHAR2, v_url IN VARCHAR2) RETURN VARCHAR2 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 PROCEDURE cs_update_referrer_type_proc() AS $func$
DECLARE
referrer_keys CURSOR IS
SELECT * FROM cs_referrer_keys
ORDER BY try_order;
func_body text;
func_cmd text;
BEGIN
func_body := 'BEGIN';
FOR referrer_key IN referrer_keys 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;
END;
$func$ LANGUAGE plpgsql;
请注意,函数体是如何单独构建并通过 quote_literal 传递以双写其中的任何引号的。这是必需的技术,因为我们无法安全地使用美元引用来定义新函数:我们不确定哪些字符串将从 referrer_key.key_string 字段插值。(我们假设 referrer_key.kind 字段的值始终是 host、domain 或 url,但 referrer_key.key_string 可能是任何内容,特别是它可能包含美元符号。)这个函数实际上是对 Oracle 原版的改进,因为它在 referrer_key.key_string 或 referrer_key.referrer_type 包含引号时不会生成损坏的代码。
示例 41.11 展示了如何移植一个带有 OUT 参数和字符串操作的函数。PostgreSQL 没有内置的 instr 函数,但您可以使用其他函数的组合来创建它。在 第 41.13.3 节中,有一个 PL/pgSQL 实现的 instr 函数,您可以使用它来简化您的移植工作。
示例 41.11. 将带字符串操作和 OUT 参数的存储过程从 PL/SQL 移植到 PL/pgSQL
下面的 Oracle PL/SQL 存储过程用于解析 URL 并返回几个元素(主机、路径和查询)。
这是 Oracle 版本
CREATE OR REPLACE PROCEDURE cs_parse_url(
v_url IN VARCHAR2,
v_host OUT VARCHAR2, -- This will be passed back
v_path OUT VARCHAR2, -- This one too
v_query OUT VARCHAR2) -- 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(
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
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');
示例 41.12 展示了如何移植一个使用了大量 Oracle 特有功能的存储过程。
示例 41.12. 将一个存储过程从 PL/SQL 移植到 PL/pgSQL
Oracle 版本
CREATE OR REPLACE PROCEDURE cs_create_job(v_job_id IN INTEGER) IS
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
COMMIT; -- free lock
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, now());
EXCEPTION
WHEN dup_val_on_index THEN NULL; -- don't worry if it already exists
END;
COMMIT;
END;
/
show errors
我们可以这样将此存储过程移植到 PL/pgSQL
CREATE OR REPLACE PROCEDURE cs_create_job(v_job_id integer) 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
COMMIT; -- free lock
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;
COMMIT;
END;
$$ LANGUAGE plpgsql;
本节解释了在将 Oracle PL/SQL 函数移植到 PostgreSQL 时需要注意的其他一些事项。
在 PL/pgSQL 中,当一个异常被 EXCEPTION 子句捕获时,自块的 BEGIN 以来的所有数据库更改都会被自动回滚。也就是说,其行为等同于你在 Oracle 中使用以下方式获得的效果:
BEGIN
SAVEPOINT s1;
... code here ...
EXCEPTION
WHEN ... THEN
ROLLBACK TO s1;
... code here ...
WHEN ... THEN
ROLLBACK TO s1;
... code here ...
END;
如果您正在翻译一个使用 SAVEPOINT 和 ROLLBACK TO 的 Oracle 存储过程,您的任务将很简单:只需省略 SAVEPOINT 和 ROLLBACK TO。如果您有一个以不同方式使用 SAVEPOINT 和 ROLLBACK TO 的存储过程,那么就需要仔细思考了。
EXECUTE #PL/pgSQL 中的 EXECUTE 版本与 PL/SQL 版本类似,但您必须记住使用 quote_literal 和 quote_ident,如 第 41.5.4 节中所述。除非使用这些函数,否则 EXECUTE 'SELECT * FROM $1'; 类型的结构将无法可靠地工作。
PostgreSQL 提供了两个函数创建修饰符来优化执行:“易变性”(volatility)(函数在给定相同参数时是否始终返回相同的结果)和“严格性”(strictness)(如果任何参数为 null,函数是否返回 null)。有关详细信息,请参阅 CREATE FUNCTION 参考页。
在使用这些优化属性时,您的 CREATE FUNCTION 语句可能看起来像这样:
CREATE FUNCTION foo(...) RETURNS integer AS $$ ... $$ LANGUAGE plpgsql STRICT IMMUTABLE;
本节包含一组 Oracle 兼容的 instr 函数的代码,您可以使用它们来简化您的移植工作。
--
-- instr functions that mimic Oracle's counterpart
-- Syntax: instr(string1, string2 [, n [, m]])
-- where [] denotes optional parameters.
--
-- Search string1, beginning at the nth character, for the mth occurrence
-- of string2. If n is negative, search backwards, starting at the abs(n)'th
-- character from the end of string1.
-- If n is not passed, assume 1 (search starts at first character).
-- If m is not passed, assume 1 (find first occurrence).
-- Returns starting index of string2 in string1, or 0 if string2 is not found.
--
CREATE FUNCTION instr(varchar, varchar) RETURNS integer AS $$
BEGIN
RETURN instr($1, $2, 1);
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;
CREATE FUNCTION instr(string varchar, string_to_search_for 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_for IN temp_str);
IF pos = 0 THEN
RETURN 0;
ELSE
RETURN pos + beg_index - 1;
END IF;
ELSIF beg_index < 0 THEN
ss_length := char_length(string_to_search_for);
length := char_length(string);
beg := length + 1 + beg_index;
WHILE beg > 0 LOOP
temp_str := substring(string FROM beg FOR ss_length);
IF string_to_search_for = temp_str THEN
RETURN beg;
END IF;
beg := beg - 1;
END LOOP;
RETURN 0;
ELSE
RETURN 0;
END IF;
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;
CREATE FUNCTION instr(string varchar, string_to_search_for 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 occur_index <= 0 THEN
RAISE 'argument ''%'' is out of range', occur_index
USING ERRCODE = '22003';
END IF;
IF beg_index > 0 THEN
beg := beg_index - 1;
FOR i IN 1..occur_index LOOP
temp_str := substring(string FROM beg + 1);
pos := position(string_to_search_for IN temp_str);
IF pos = 0 THEN
RETURN 0;
END IF;
beg := beg + pos;
END LOOP;
RETURN beg;
ELSIF beg_index < 0 THEN
ss_length := char_length(string_to_search_for);
length := char_length(string);
beg := length + 1 + beg_index;
WHILE beg > 0 LOOP
temp_str := substring(string FROM beg FOR ss_length);
IF string_to_search_for = temp_str 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;
ELSE
RETURN 0;
END IF;
END;
$$ LANGUAGE plpgsql STRICT IMMUTABLE;