pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
Roberto Mello(<rmello@fslc.usu.edu>)
本节解释 Oracle 的 PL/SQL 与 PostgreSQL 的 PL/pgSQL 语言之间的差异,希望能帮助开发者把 应用程序从 Oracle 移植到 PostgreSQL。这里的大部分代码 来自 ArsDigita 的 Clickstream 模块,那是我 2000 年夏天在 OpenForce Inc. 实习期间 移植到 PostgreSQL 的。
PL/pgSQL 在许多方面与 PL/SQL 相似。它是一种 块结构的命令式语言(所有变量都必须声明)。PL/SQL 的功能比 PostgreSQL 的对应语言多得多,但 PL/pgSQL 提供了大量功能,并且正在不断改进。
从 Oracle 移植到 PostgreSQL 时要记住的一些事项:
PostgreSQL 中没有默认参数。
在 PostgreSQL 中可以重载函数。这常被用来绕开缺少 默认参数的问题。
赋值、循环和条件都相似。
PostgreSQL 中不需要游标,把查询放进 FOR 语句即可(见下面的例子)
在 PostgreSQL 中你需要转义 单引号。见 第 19.11.1.1 节。
在 PostgreSQL 中,你需要转义函数定义内部的单引号。 这有时会导致相当有趣的代码,尤其是当你创建一个生成其他函数的函数时, 如 例 19.6 中那样。转义大量单引号时 要记住的一件事是:除开头/结尾的引号外,所有其他引号都将以偶数个出现。
表 19.1 给出了全部内幕。(你会喜欢这张 小图表的。)
表 19.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 个引号) 并且终止该字符串(再加 2 个)。只有当你用 函数生成其他函数时(如 例 19.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; |
例 19.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 的差异:
PostgreSQL 没有命名参数。你必须在 函数内部显式地为它们建立别名。
Oracle 的函数可以有 IN、OUT 和 INOUT 参数。例如 INOUT 表示参数将接收一个值并返回另一个值。PostgreSQL 只有“IN”参数,而且函数只能返回单个值。
函数原型(不是函数体)中的 RETURN 关键字在 PostgreSQL 中变为 RETURNS。
在 PostgreSQL 中,函数是用单引号作为定界符创建的, 因此你必须转义函数内部的单引号(这有时相当恼人;参见 第 19.11.1.1 节)。
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';
例 19.6. 一个创建另一个函数的函数
下面的过程从 SELECT 语句抓取行,并把结果用 IF 语句构造成一个大函数,以求高效。请特别注意 游标、FOR 循环中的差异,以及在 PostgreSQL 中转义单引号的必要性。
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'''';'';
-- This works 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';
例 19.7. 一个带大量字符串处理和 OUT 参数的过程
下面的 Oracle PL/SQL 过程用于解析 URL 并返回若干元素(主机、路径和 查询)。它是一个过程,因为在 PL/pgSQL 中 函数只能返回一个值(见 第 19.11.3 节)。 在 PostgreSQL 中,绕过这个问题的一种办法是把过程拆成 三个不同的函数:一个返回主机,一个返回路径,一个返回查询。
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, '//'); -- PostgreSQL doesn't have an instr function
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 的可能样子:
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';
PostgreSQL 没有 instr 函数, 因此你可以用其他函数的组合来绕过。我对这样做感到厌倦,于是编写了 自己的 instr 函数,其行为与 Oracle 的完全一样 (这让生活更轻松)。代码见 第 19.11.6 节。
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 函数。这个过程特别有意思,因为它能教给 我们一些东西:
|
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;
-- 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
-- This job is not in the table so lets insert it.
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';
|
注意你可以在 PL/pgSQL 中引发通知(或错误)。 |
我自己对包用得不多,如果这里有错误,请告诉我。
包是 Oracle 提供的一种把 PL/SQL 语句和函数封装到一个实体中的方式, 就像 Java 类一样,你在其中定义方法和对象。可以用一个 “.”(点)来访问这些对象/方法。下面是 ACS 4(ArsDigita Community System)中一个 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,TIMESTAMP,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';
PostgreSQL 版的 EXECUTE 工作良好, 但你必须记得按 第 19.5.4 节 中所述使用 quote_literal(TEXT) 和 quote_string(TEXT)。 EXECUTE ''SELECT * from $1''; 这类构造除非使用了 这些函数,否则不会工作。
PostgreSQL 提供两个函数创建修饰符用于优化执行: iscachable(函数在给定相同参数时总是返回相同的 结果)和 isstrict(函数在任何参数为空时返回空)。 详情请查阅 CREATE FUNCTION 参考页。
要利用这些优化属性,你的 CREATE FUNCTION 语句中 必须使用 WITH 修饰符。类似这样:
CREATE FUNCTION foo(...) RETURNS INTEGER AS ' ... ' LANGUAGE 'plpgsql' WITH (isstrict, iscachable);
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 (rmello@fslc.usu.edu)
-- modified by Robert Gaszewski (graszew@poland.com)
-- Licensed under the GPL v2 or later.
--
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,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 (graszew@poland.com)
-- Licensed under the GPL v2 or later.
--
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';
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。