pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
这一节解释了 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 行为,这不是默认行为,如 第 39.10.1 节 所述。通常最好一开始就避免 这种歧义,但如果必须移植大量依赖这种行为的代码,设置 variable_conflict 可能是最好的解决办法。
在 PostgreSQL 中,函数体必须写成 字符串字面量。因此你需要使用美元符引用或者转义函数体中的 单引号(见 第 39.11.1 节)。
应该用模式把函数组织成不同的分组,而不是用包。
因为没有包,所以也没有包级变量。这一点有时会带来不便。你 可以改为在临时表中保存会话级状态。
带有 REVERSE 的整数 FOR 循环的工作方式不同: PL/SQL 中是从第二个数向第一个数 倒数,而 PL/pgSQL 是从第一个数向 第二个数倒数,因此在移植时需要交换循环边界。不幸的是这种 不兼容性是不太可能改变的(见 第 39.6.3.5 节)。
查询上的 FOR 循环(不是游标)的工作方式 同样不同:目标变量必须已经被声明,而 PL/SQL 总是会隐式地声明它们。但是 这样做的优点是在退出循环后,变量值仍然可以访问。
在使用游标变量方面,存在一些记法差异。
例 39.6 展示了如何把一个简单的函数 从 PL/SQL 移植到 PL/pgSQL。
例 39.6. 把一个简单的函数从 PL/SQL 移植到 PL/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;
例 39.7 展示了如何移植一个会创建 另一个函数的函数,以及如何处理随之而来的引号问题。
例 39.7. 从 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 VARCHAR,
v_domain IN VARCHAR, v_url IN VARCHAR) RETURN VARCHAR 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 FUNCTION cs_update_referrer_type_proc() RETURNS void 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 中包含 引号时,它也不会生成有问题的代码。
例 39.8 展示了如何移植一个带有 OUT 参数和字符串处理的函数。 PostgreSQL 没有内置的 instr 函数,但是你可以用其它函数的组合来 创建一个。 在 第 39.12.3 节 中有一个 instr 的 PL/pgSQL 实现,你可以用它让你的移植 变得更容易。
例 39.8. 从 PL/SQL 移植一个带有字符串操作以及 OUT 参数的过程到 PL/pgSQL
下面的 Oracle PL/SQL 过程被用来解析 一个 URL 并且返回一些元素(主机、路径和查询)。
This is the Oracle version:
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(
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');
例 39.9 展示了如何移植一个使用了 大量 Oracle 专有特性的过程。
例 39.9. 从 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
END;
COMMIT;
END;
/
show errors
这样的过程可以很容易地转换为 PostgreSQL 中返回 void 的函数。这个过程尤其值得关注,因为它能说明 以下几点:
|
PostgreSQL 中没有 |
|
|
如果在 PL/pgSQL 中执行 |
|
|
不能在 PL/pgSQL 函数中发出 |
我们可以像这样把这个过程移植到 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;
|
|
|
|
PL/pgSQL 支持的异常名与 Oracle 的 不同。内置异常名的集合要大得多(见 附录 A)。目前没有办法声明用户 自定义的异常名,但你可以在抛出时使用自己选择的 SQLSTATE 值。 |
这个过程与 Oracle 等价版本在功能上的主要区别是,对 cs_jobs 表的排他锁会一直保持到调用事务完成。 此外,如果调用者随后中止(例如由于错误),该过程的效果也会被 回滚。
本节说明在把 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 即可。如果你的 Oracle 过程以 不同方式使用 SAVEPOINT 和 ROLLBACK TO,那就需要认真思考了。
EXECUTEPL/pgSQL 中的 EXECUTE 与 PL/SQL 中的版本工作方式相似,但必须 记得按照 第 39.5.4 节 中的说明使用 quote_literal 和 quote_ident。像 EXECUTE 'SELECT * FROM $1'; 这样的写法如果不 借助这些函数,将无法可靠地工作。
PostgreSQL 提供了两种函数创建修饰符 来优化执行:“volatility”(对于给定的相同参数, 函数是否总是返回相同的结果)以及 “strictness”(如果任何参数为空值,函数是否返回 空值)。详见 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.
--
-- 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 STRICT IMMUTABLE;
CREATE FUNCTION instr(string varchar, string_to_search 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 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
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;
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。