44.2. PL/Tcl 函数和参数#

要在PL/Tcl语言中创建函数，请使用标准CREATE FUNCTION语法

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

PL/TclU相同，只是语言必须指定为pltclu。

函数的主体只是一段 Tcl 脚本。调用函数时，参数值将作为名为1...*n*的变量传递给 Tcl 脚本。结果以通常的方式通过return语句从 Tcl 代码返回。在过程中，将忽略 Tcl 代码的返回值。

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

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

请注意STRICT子句，它让我们不必考虑 null 输入值：如果传递 null 值，则根本不会调用函数，而只会自动返回 null 结果。

在非严格函数中，如果参数的实际值为 null，则相应的$*n*变量将被设置为一个空字符串。要检测某个参数是否为 null，请使用argisnull函数。例如，假设我们希望tcl_max带有一个 null 参数和一个非 null 参数，以返回非 null 参数，而不是 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 函数返回 null 值，请执行return_null。无论函数是否严格，都可以执行此操作。

复合类型参数作为 Tcl 数组传递给函数。数组的元素名称是复合类型的属性名称。如果传递的行中的属性具有 null 值，则它将不会出现在数组中。以下是一个示例

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 命令array get从所需元组的数组表示形式创建结果列表。例如

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

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;

44.2. PL/Tcl 函数和参数# ​

44.2. PL/Tcl 函数和参数#