本节解释 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,如
Section 41.11.1 中所解释的。
通常最好从一开始就避免这类歧义,
但如果你必须迁移大量依赖这一行为的代码,
设置 variable_conflict 可能是最好的解决办法。
在 PostgreSQL 中,函数体必须写成 字符串字面值。因此你需要使用美元符引用, 或在函数体中转义单引号。(见 Section 41.12.1。)
数据类型的名称经常需要转换。例如,在 Oracle 中,
字符串值通常被声明为 varchar2 类型,
这是一种非 SQL 标准的类型。在
PostgreSQL 中,
应改用 varchar 或 text 类型。
类似地,把 number 类型替换为
numeric,或者如有更合适的其他数值数据类型
就使用它。
用模式(schema)取代包(package)来把函数组织成组。
由于没有包,也就没有包级变量。这多少有些令人烦恼。 你可以改为在临时表中保存每会话的状态。
带 REVERSE 的整数 FOR
循环工作方式不同:PL/SQL
从第二个数向第一个数倒数,而
PL/pgSQL 从第一个数向第二个数倒数,
因此迁移时需要交换循环边界。这一不兼容性令人遗憾,
但不太可能被改变。(见 Section 41.6.5.5。)
对查询的 FOR 循环(游标除外)的工作方式
也有所不同:目标变量必须先被声明,
而 PL/SQL 总是隐式声明它们。
这样做的一个优点是,循环退出后变量值仍然可以访问。
游标变量的使用在记法上存在各种差异。
Example 41.9 展示了如何把一个简单的函数 从 PL/SQL 迁移到 PL/pgSQL。
Example 41.9. Porting a Simple Function from PL/SQL to 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;
Example 41.10 展示了如何迁移一个 会创建另一个函数的函数,以及如何处理随之而来的引用问题。
Example 41.10. Porting a Function that Creates Another Function from PL/SQL to 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
包含引号时,它不会生成损坏的代码。
Example 41.11 展示了如何迁移一个带
OUT 参数并涉及字符串处理的函数。
PostgreSQL 没有内建的
instr 函数,但你可以用其他函数组合
创建一个。在 Section 41.13.3 中有一个
instr 的
PL/pgSQL 实现,
可以用它来简化你的迁移工作。
Example 41.11. Porting a Procedure With String Manipulation and
OUT Parameters from PL/SQL to
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');
Example 41.12 展示了如何迁移一个 使用了大量 Oracle 特有功能的过程。
Example 41.12. Porting a Procedure from PL/SQL to 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;
| |
PL/pgSQL 支持的异常名与 Oracle 的不同。 内建异常名的集合要大得多(见 Appendix A)。目前没有办法声明 用户定义的异常名,不过你可以改为抛出用户选择的 SQLSTATE 值。 |
本节解释把 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
的过程,那就需要动一番脑筋了。
PL/pgSQL 版本的
EXECUTE 的工作方式与
PL/SQL 版本类似,
但你必须记得按照 Section 41.5.4 中的描述使用
quote_literal 和
quote_ident。形如
EXECUTE 'SELECT * FROM $1';
的构造除非使用了这些函数,否则无法可靠地工作。
PostgreSQL 提供两个函数创建修饰符 来优化执行:“易变性”(函数在给定相同参数时 是否总是返回相同的结果)和“严格性”(如果任一参数为空, 函数是否返回空值)。详情请查阅 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;