40.6. 控制结构

40.6.1.1. RETURN

RETURN expression;

带表达式的RETURN用于终止函数 并把expression的值返回给调用者。 这种形式用于不返回集合的PL/pgSQL函数。

如果函数中返回标量类型，那么表达式结果将被自动转换成函数的返回类型， 就像在赋值中描述的那样。但是要返回一个复合(行)数值， 你必须写一个准确提供需求列集合的表达式，这可能需要显式转换。

如果你声明带有输出参数的函数，那么就只需要写无表达式的RETURN。 那么输出参数变量的当前值将被返回。

如果你声明函数返回void，那么一个RETURN 语句可以用于提前退出函数； 但是不要在RETURN后面写一个表达式。

一个函数的返回值不能是未定义。 如果控制到达了函数最顶层的块而没有碰到一个RETURN语句， 那么它就会发生一个错误。不过，这个限制不适用于带输出参数的函数以及那些返回void的函数。 在这些例子里，如果顶层的块结束，则自动执行一个RETURN语句。

例子：

-- 返回一个标量类型函数
RETURN 1 + 2;
RETURN scalar_var;
-- 返回复合类型函数
RETURN composite_type_var;
RETURN (1, 2, 'three'::text);  -- must cast columns to correct types

40.6.1.2. RETURN NEXT和RETURN QUERY

RETURN NEXT expression;
RETURN QUERY query;
RETURN QUERY EXECUTE command-string [ USING expression [, ... ] ];

如果一个PL/pgSQL函数声明为返回SETOF sometype， 那么遵循的过程则略有不同。 在这种情况下，要返回的独立项是在RETURN NEXT或者 RETURN QUERY命令里声明的， 然后最后有一个不带参数的RETURN命令用于告诉这个函数已经完成执行了。 RETURN NEXT可以用于标量和复合数据类型；对于复合类型， 将返回一个完整的结果"table"。 RETURN QUERY命令将一条查询的结果追加到一个函数的结果集中。 RETURN NEXT和RETURN QUERY在单一集合返回 函数中自由混合，在这种情况下，结果将被级联。

RETURN NEXT和RETURN QUERY实际上不会从函数中返回， 它们是将零或者多个行追加到函数的结果集中。 然后继续执行PL/pgSQL函数里的下一条语句。 随着后继的RETURN NEXT或者RETURN QUERY命令的执行， 结果集就建立起来了。最后一个RETURN应该没有参数， 它导致控制退出该函数(或者你可以简单地让控制到达函数的结尾)。

RETURN QUERY有一个变形RETURN QUERY EXECUTE， 指定查询将被动态执行。 参数表达式可以通过USING插入到计算查询字符串中，以EXECUTE命令的同样方式。

如果你声明函数带有输出参数，那么就只需要写不带表达式的RETURN NEXT。 输出参数的当前值将被保存，用于最终返回。请注意如果有多个输出参数， 比如声明函数为返回SETOF record或者是在只有一个类 型为sometype的输出参数时声明 为SETOF sometype， 这样才能创建一个带有输出参数的返回集合的函数。

下面是一个使用RETURN NEXT的函数例子:

CREATE TABLE foo (fooid INT, foosubid INT, fooname TEXT);
INSERT INTO foo VALUES (1, 2, 'three');
INSERT INTO foo VALUES (4, 5, 'six');

CREATE OR REPLACE FUNCTION get_all_foo() RETURNS SETOF foo AS
$BODY$
DECLARE
    r foo%rowtype;
BEGIN
    FOR r IN
        SELECT * FROM foo WHERE fooid > 0
    LOOP
   
-- 可以在这里做一些处理
        RETURN NEXT r; -- return current row of SELECT
    END LOOP;
    RETURN;
END
$BODY$
LANGUAGE plpgsql;

SELECT * FROM get_all_foo();

这是一个使用RETURN QUERY的函数例子:

CREATE FUNCTION get_available_flightid(date) RETURNS SETOF integer AS
$BODY$
BEGIN
    RETURN QUERY SELECT flightid
                   FROM flight
                  WHERE flightdate >= $1
                    AND flightdate < ($1 + 1);
    
-- 由于没有完成执行，我们可以检查行是否返回并且如果没有则抛出异常。
    IF NOT FOUND THEN
        RAISE EXCEPTION 'No flight at %.', $1;
    END IF;

    RETURN;
 END
$BODY$
LANGUAGE plpgsql;
-- 如果没有可用航班，则返回可用航班或者抛出异常。
SELECT * FROM get_available_flightid(CURRENT_DATE);

40.6.2.1. IF-THEN

IF boolean-expression THEN
    statements
END IF;

IF-THEN语句是IF的最简单形式。如果条件为真， 在THEN和END IF之间的语句将被执行。 否则，将忽略它们。

例如：

IF v_user_id <> 0 THEN
    UPDATE users SET email = v_email WHERE user_id = v_user_id;
END IF;

40.6.2.2. IF-THEN-ELSE

IF boolean-expression THEN
    statements
ELSE
    statements
END IF;

IF-THEN-ELSE语句增加了IF-THEN的分支， 让你可以声明在条件为假的时候执行的语句。（请注意这包含条件是NULL的情况）。

例如：

IF parentid IS NULL OR parentid = ''
THEN
    RETURN fullname;
ELSE
    RETURN hp_true_filename(parentid) || '/' || fullname;
END IF;

IF v_count > 0 THEN
    INSERT INTO users_count (count) VALUES (v_count);
    RETURN 't';
ELSE
    RETURN 'f';
END IF;

40.6.2.3. IF-THEN-ELSIF

IF boolean-expression THEN
    statements
[ ELSIF boolean-expression THEN
    statements
[ ELSIF boolean-expression THEN
    statements
    ...]]
[ ELSE
    statements ]
END IF;

有时不止两个选择。IF-THEN-ELSIF 反过来提供了一个简便的方法来检查选择条件。 IF判断会陆续检查，直到找到第一个为真的，然后执行相关声明，如此， 直到END IF（不会检测IF子查询）。 如果没有一个条件符合IF判断，那么会接着执行ELSE判断。

例如：

IF number = 0 THEN
    result := 'zero';
ELSIF number > 0 THEN
    result := 'positive';
ELSIF number < 0 THEN
    result := 'negative';
ELSE
    
-- 唯一可能性是号码为空
    result := 'NULL';
END IF;

ELSIF关键字也可以写成ELSEIF。

另一个可以实现该目的的方法是使用IF-THEN-ELSE声明，如下:

IF demo_row.sex = 'm' THEN
    pretty_sex := 'man';
ELSE
    IF demo_row.sex = 'f' THEN
        pretty_sex := 'woman';
    END IF;
END IF;

然而，这个方法需要为每个IF写END IF， 因此当有很多选择时，这种方法明显比ELSIF繁琐。

40.6.2.4. 简单CASE

CASE search-expression
    WHEN expression [, expression [ ... ]] THEN
      statements
  [ WHEN expression [, expression [ ... ]] THEN
      statements
    ... ]
  [ ELSE
      statements ]
END CASE;

CASE简单的形式提供基于操作数平等的条件执行。search-expression被评价并且 先后比较WHEN子句中的每个表达式。 如果找到匹配，那么相应的statements被执行， 然后控制在END CASE之后传递到下一个语句。 （随后的WHEN表达式不被评估。） 如果没有发现匹配，执行ELSE statements； 但如果ELSE是不存在的，然后引发CASE_NOT_FOUND异常。

例如：

CASE x
    WHEN 1, 2 THEN
        msg := 'one or two';
    ELSE
        msg := 'other value than one or two';
END CASE;

40.6.2.5. 搜索CASE

CASE
    WHEN boolean-expression THEN
      statements
  [ WHEN boolean-expression THEN
      statements
    ... ]
  [ ELSE
      statements ]
END CASE;

CASE搜索形式基于布尔表达式的真理提供条件执行。 每个WHEN子句的boolean-expression依次被评估， 直到找到一个产生true为止。 然后执行相应的statements， 控制END CASE之后传递到下一个语句。 （随后不评估WHEN表达式）。 如果发现没有真实结果，则执行ELSEstatements； 但如果ELSE是不存在的，那么引发 CASE_NOT_FOUND异常。

例如：

CASE
    WHEN x BETWEEN 0 AND 10 THEN
        msg := 'value is between zero and ten';
    WHEN x BETWEEN 11 AND 20 THEN
        msg := 'value is between eleven and twenty';
END CASE;

CASE这种形式完全等价于 IF-THEN-ELSIF，除了达到忽略错误中的ELSE子句结果而不是什么都不做的规则。

40.6.3.1. 循环

[ <<label>> ]
LOOP
    statements
END LOOP [ label ];

LOOP定义一个无条件的循环，无限循环， 直到由EXIT或者 RETURN语句终止。 可选的label可以由EXIT 和CONTINUE语句使用， 用于在嵌套循环中声明应该应用于哪一层循环。

40.6.3.2. 退出

EXIT [ label ] [ WHEN boolean-expression ];

如果没有给出label，那么退出最内层的循环， 然后执行跟在END LOOP后面的语句。 如果给出label， 那么它必须是当前或者更高层的嵌套循环块或者语句块的标签。 然后该命名块或者循环就会终止，而控制落到对应循环/块的END语句后面的语句上。

如果声明了WHEN， 循环退出只有在boolean-expression为真的时候才发生， 否则控制会落到EXIT后面的语句上。

EXIT可以用于在所有的循环类型中，它并不仅仅限制于在无条件循环中使用。

在和BEGIN块一起使用的时候，EXIT把控制交给块结束后的下一个语句。 需要注意的是，一个标签必须用于这个目的； 一个没有标记的EXIT永远无法与BEGIN进行匹配。 （这是PostgreSQL 8.4之前版本的一个变化， 这将允许未标记EXIT匹配BEGIN块）。

例如：

LOOP
    
-- 一些计算
    IF count > 0 THEN
        EXIT;  -- exit loop
    END IF;
END LOOP;

LOOP
    
-- 一些计算
EXIT WHEN count > 0;  -- 和前面的例子相同结果
END LOOP;

<<ablock>>
BEGIN
    
-- 一些计算
    IF stocks > 100000 THEN
    EXIT ablock;  -- 导致从BEGIN块退出
    END IF;
 -- 忽略这儿的计算，当stocks > 100000时
END;

40.6.3.3. CONTINUE

CONTINUE [ label ] [ WHEN boolean-expression ];

如果没有给出label，那么就开始最内层循环的下一次执行。 也就是说，控制传递回给循环控制表达式(如果有)，然后重新计算循环体。 如果出现了label，它声明即将继续执行的循环的标签。

如果声明了WHEN，那么循环的下一次执行只有 在boolean-expression为真的情况下才进行。 否则，控制传递给CONTINUE后面的语句。

CONTINUE可以用于所有类型的循环；它并不仅仅限于无条件循环。

例如：

LOOP
    
-- 一些计算
    EXIT WHEN count > 100; 
    CONTINUE WHEN count < 50;
-- 在[50 .. 100]内的计算
END LOOP;

40.6.3.4. WHILE

[ <<label>> ]
WHILE boolean-expression LOOP
    statements
END LOOP [ label ];

只要条件表达式（boolean-expression）为真， WHILE语句就会不停的在一系列语句上进行循环， 条件是在每次进入循环体的时候被检查。

例如：

WHILE amount_owed > 0 AND gift_certificate_balance > 0 LOOP
    -- 这里的一些计算
END LOOP;

WHILE NOT done LOOP
    -- 这里的一些计算
END LOOP;

40.6.3.5. FOR (Integer 变量)

[ <<label>> ]
FOR name IN [ REVERSE ] expression .. expression [ BY expression ] LOOP
    statements
END LOOP [ label ];

这种形式的FOR对一定范围的整数进行迭代的循环。 变量name会自动定义为BY类型并且只在循环里存在 (任何该变量名的现存定义在此循环内都将被忽略)。 给出范围上下界的两个表达式在进入循环的时候计算一次。 BY子句指定迭代步长(缺省为 1)， 但如果声明了REVERSE步长将变为相应的负值。

一些整数FOR循环的例子：

FOR i IN 1..10 LOOP
    -- 我将在值1,2,3,4,5,6,7,8,9,10中循环
END LOOP;

FOR i IN REVERSE 10..1 LOOP
    -- 将在值10,9,8,7,6,5,4,3,2,1中循环
END LOOP;

FOR i IN REVERSE 10..1 BY 2 LOOP
    -- 将在值10,8,6,4,2中循环
END LOOP;

如果下界大于上界(或者是在REVERSE情况下是小于)， 那么循环体将完全不被执行。 而且不会抛出任何错误。

如果label被附加到FOR循环，那么整数循环变量 可以使用label引用适当名称。

40.6.6.1. 获得有关错误的信息

异常处理程序经常需要确定发生的具体错误。有两种方法来获得 当前PL/pgSQL异常： 特殊变量和GET STACKED DIAGNOSTICS命令 的有关信息。

在一个异常处理程序中，特殊变量 SQLSTATE包含相当于发生异常的错误代码 （参考Table A-1获得可能错误代码列）。 特殊变量SQLERRM包含与异常有关的错误消息。 这些变量是在异常处理外未被定义的。

在一个异常处理程序中，也可以检索关于使用GET STACKED DIAGNOSTICS命令的当前异常信息，形成了：

GET STACKED DIAGNOSTICS variable = item [ , ... ];

每个item是识别被分配到指定变量的状态值（应该是接收它的正确数据类型）的一个关键字。 目前可用的状态显示在Table 40-1中。

如果异常没有设置项值，则返回空字符串。

例子：

DECLARE
  text_var1 text;
  text_var2 text;
  text_var3 text;
BEGIN
  
  -- 一些处理可能引起异常
  ...
EXCEPTION WHEN OTHERS THEN
  GET STACKED DIAGNOSTICS text_var1 = MESSAGE_TEXT,
                          text_var2 = PG_EXCEPTION_DETAIL,
                          text_var3 = PG_EXCEPTION_HINT;
END;