# 44.2.PL/Tcl函数和参数

要使用PL/Tcl语言创建函数,请使用标准创建函数语法:

CREATE FUNCTION funcname (argument-types) RETURNS return-type AS $$
    # PL/Tcl function body
$$ LANGUAGE pltcl;

PL/TclU是相同的,只是语言必须指定为pltclu.

函数的主体只是一段Tcl脚本。调用函数时,参数值作为名为1....*n*.结果以通常的方式从Tcl代码返回,带有回来陈述在过程中,Tcl代码的返回值被忽略。

例如,返回两个整数值中较大值的函数可以定义为:

CREATE FUNCTION tcl_max(integer, integer) RETURNS integer AS $$
    if {$1 > $2} {return $1}
    return $2
$$ LANGUAGE pltcl STRICT;

注意这个条款严格的,这使我们不必考虑空输入值:如果传递了空值,函数将根本不会被调用,而只会自动返回空结果。

在非严格函数中,如果参数的实际值为null,则相应的$*n*变量将被设置为空字符串。要检测特定参数是否为null,请使用函数argisnull.例如,假设我们想要tcl_max使用一个null和一个nonnull参数返回nonnull参数,而不是null:

CREATE FUNCTION tcl_max(integer, integer) RETURNS integer AS $$
    if {[argisnull 1]} {
        if {[argisnull 2]} { return_null }
        return $2
    }
    if {[argisnull 2]} { return $1 }
    if {$1 > $2} {return $1}
    return $2
$$ LANGUAGE pltcl;

如上所示,要从PL/Tcl函数返回空值,请执行返回空.无论函数是否严格,都可以这样做。

复合类型参数作为Tcl数组传递给函数。数组的元素名是复合类型的属性名。如果传递行中的属性具有空值,则该属性不会出现在数组中。下面是一个例子:

CREATE TABLE employee (
    name text,
    salary integer,
    age integer
);

CREATE FUNCTION overpaid(employee) RETURNS boolean AS $$
    if {200000.0 < $1(salary)} {
        return "t"
    }
    if {$1(age) < 30 && 100000.0 < $1(salary)} {
        return "t"
    }
    return "f"
$$ LANGUAGE pltcl;

PL/Tcl函数也可以返回复合类型的结果。为此,Tcl代码必须返回与预期结果类型匹配的列名/值对列表。从列表中省略的任何列名都将作为null返回,如果存在意外的列名,则会引发错误。下面是一个例子:

CREATE FUNCTION square_cube(in int, out squared int, out cubed int) AS $$
    return [list squared [expr {$1 * $1}] cubed [expr {$1 * $1 * $1}]]
$$ LANGUAGE pltcl;

过程的输出参数以相同的方式返回,例如:

CREATE PROCEDURE tcl_triple(INOUT a integer, INOUT b integer) AS $$
    return [list a [expr {$1 * 3}] b [expr {$2 * 3}]]
$$ LANGUAGE pltcl;

CALL tcl_triple(5, 10);

# 提示

结果列表可以通过使用数组获取Tcl命令。例如:

CREATE FUNCTION raise_pay(employee, delta int) RETURNS employee AS $$
    set 1(salary) [expr {$1(salary) + $2}]
    return [array get 1]
$$ LANGUAGE pltcl;

PL/Tcl函数可以返回集合。为此,Tcl代码应该调用下次再来每返回一行一次,在返回标量类型时传递适当的值,或在返回复合类型时传递列名/值对列表。下面是一个返回标量类型的示例:

CREATE FUNCTION sequence(int, int) RETURNS SETOF int AS $$
    for {set i $1} {$i < $2} {incr i} {
        return_next $i
    }
$$ LANGUAGE pltcl;

下面是一个返回复合类型的示例:

CREATE FUNCTION table_of_squares(int, int) RETURNS TABLE (x int, x2 int) AS $$
    for {set i $1} {$i < $2} {incr i} {
        return_next [list x $i x2 [expr {$i * $i}]]
    }
$$ LANGUAGE pltcl;