要在 PL/Tcl 语言中创建函数,请使用标准的 CREATE FUNCTION 语法
CREATE FUNCTIONfuncname
(argument-types
) RETURNSreturn-type
AS $$ # PL/Tcl function body $$ LANGUAGE pltcl;
PL/TclU 相同,只不过语言必须指定为 pltclu
。
函数的主体只是一个 Tcl 脚本片段。调用函数时,参数值会作为变量 1
...
传递给 Tcl 脚本。结果以通常的方式在 Tcl 代码中返回,使用 n
return
语句。在一个过程中,Tcl 代码的返回值会被忽略。
例如,可以将一个返回两个整数值中较大值函数定义为
CREATE FUNCTION tcl_max(integer, integer) RETURNS integer AS $$ if {$1 > $2} {return $1} return $2 $$ LANGUAGE pltcl STRICT;
注意 STRICT
子句,它可使我们不必考虑空输入值:如果传递空值,该函数根本不会被调用,而会自动返回空结果。
在非严格函数中,如果某个参数的实际值为空,相应的 $
变量将被设置为一个空字符串。要检测某个特定参数是否为空,请使用 n
argisnull
函数。例如,假设我们希望 tcl_max
函数在具有一个空参数和一个非空参数时返回非空参数,而不是空值
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 函数返回空值,请执行 return_null
。无论函数是否严格,都可以执行此操作。
复合类型参数作为 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);
可以使用带 array get
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 代码应按要返回的每行调用 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;