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中你需要 转义单引号。参见第 23.11.1.1 节。
在PostgreSQL中,你需要转义函数定义内部的 单引号。这有时会导致相当有趣的代码,尤其是当你在创建一个 会生成其他函数的函数时,就像 例 23.6中那样。在转义大量 单引号时要记住的一点是:除开头/结尾的引号外,其余引号都 会成对出现。
表 23.1给出了全部诀窍。(你会爱上 这张小表的。)
表 23.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 个)时。 只有在你用一个函数生成其他函数时才可能需要这样做 (就像例 23.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; |
例 23.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中,创建函数使用单引号 作为定界符,因此你必须转义函数内部的单引号(这有时会相当 令人厌烦;参见第 23.11.1.1 节)。
/show errors命令在 PostgreSQL中不存在。
那么让我们看看这个函数移植到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';
例 23.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';
例 23.7. 一个带大量字符串操作和 OUT 参数的过程
下面的 Oracle PL/SQL 过程用于解析 URL 并返回若干元素(主机、 路径和查询)。它是一个过程,因为在PL/pgSQL 中函数只能返回一个值(参见 第 23.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 的完全 一致(这让生活更轻松)。代码见 第 23.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,DATETIME,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 工作得很好,但你必须记住按照 第 23.5.4 节中的说明 使用quote_literal(TEXT)和 quote_string(TEXT)。像 EXECUTE ''SELECT * from $1'';这类构造如果 不使用这些函数就无法工作。
PostgreSQL提供了两个函数创建修饰符来 优化执行:iscachable(给定相同参数时函数总是 返回相同结果)和isstrict(任一参数为 NULL 时 函数返回 NULL)。细节请查阅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 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。