在本节中,我们遵循通常的 Tcl 约定,使用问号而不是方括号来表示语法概要中的可选元素。以下命令可用于从 PL/Tcl 函数的主体访问数据库
spi_exec
?-count n
? ?-array name
? command
?loop-body
?
执行给定为字符串的 SQL 命令。命令中的错误会导致引发错误。否则,spi_exec
的返回值是命令处理(选择、插入、更新或删除)的行数,如果命令是实用程序语句,则为零。此外,如果命令是 SELECT
语句,则选定列的值将放置在 Tcl 变量中,如下所述。
可选的 -count
值告诉 spi_exec
一旦检索到 n
行就停止,就像查询包含 LIMIT
子句一样。如果 n
为零,则查询将运行到完成,与省略 -count
时相同。
如果命令是 SELECT
语句,则结果列的值将放置到以列名命名的 Tcl 变量中。如果给出了 -array
选项,则列值将存储到命名关联数组的元素中,列名用作数组索引。此外,结果中的当前行号(从零开始计数)将存储到名为 “.tupno
” 的数组元素中,除非该名称在结果中用作列名。
如果命令是 SELECT
语句并且未给出 loop-body
脚本,则只有第一行结果存储到 Tcl 变量或数组元素中;如果存在剩余行,则会被忽略。如果查询不返回任何行,则不会发生存储。(可以通过检查 spi_exec
的结果来检测这种情况。)例如
spi_exec "SELECT count(*) AS cnt FROM pg_proc"
会将 Tcl 变量 $cnt
设置为 pg_proc
系统目录中的行数。
如果给出了可选的 loop-body
参数,则它是为查询结果中的每一行执行一次的一段 Tcl 脚本。(如果给定的命令不是 SELECT
,则会忽略 loop-body
。)在每次迭代之前,当前行的列值都会存储到 Tcl 变量或数组元素中。例如
spi_exec -array C "SELECT * FROM pg_class" { elog DEBUG "have table $C(relname)" }
将为 pg_class
的每一行打印一条日志消息。此功能的工作方式与其他 Tcl 循环构造类似;特别是在循环体内部,continue
和 break
以通常的方式工作。
如果查询结果的列为空,则该列的目标变量将“unset”,而不是被设置。
spi_prepare
query
typelist
准备并保存查询计划以供以后执行。保存的计划将在当前会话的生命周期内保留。
查询可以使用参数,即在实际执行计划时要提供的值的占位符。在查询字符串中,通过符号 $1
... $
引用参数。如果查询使用参数,则必须将参数类型的名称作为 Tcl 列表给出。(如果未使用任何参数,请为 n
typelist
写入一个空列表。)
spi_prepare
的返回值是一个查询 ID,该 ID 将在后续调用 spi_execp
时使用。有关示例,请参见 spi_execp
。
spi_execp
?-count n
? ?-array name
? ?-nulls string
? queryid
?value-list
? ?loop-body
?
执行先前使用 spi_prepare
准备的查询。queryid
是 spi_prepare
返回的 ID。如果查询引用参数,则必须提供 value-list
。这是一个 Tcl 参数实际值的列表。该列表的长度必须与先前提供给 spi_prepare
的参数类型列表相同。如果查询没有参数,则省略 value-list
。
-nulls
的可选值是一个由空格和 'n'
字符组成的字符串,告诉 spi_execp
哪些参数为空值。如果给出,则它必须与 value-list
的长度完全相同。如果未给出,则所有参数值均不为空。
除了指定查询及其参数的方式之外,spi_execp
的工作方式与 spi_exec
完全相同。-count
、-array
和 loop-body
选项相同,并且结果值也相同。
以下是使用准备好的计划的 PL/Tcl 函数示例
CREATE FUNCTION t1_count(integer, integer) RETURNS integer AS $$ if {![ info exists GD(plan) ]} { # prepare the saved plan on the first call set GD(plan) [ spi_prepare \ "SELECT count(*) AS cnt FROM t1 WHERE num >= \$1 AND num <= \$2" \ [ list int4 int4 ] ] } spi_execp -count 1 $GD(plan) [ list $1 $2 ] return $cnt $$ LANGUAGE pltcl;
我们需要 spi_prepare
给出的查询字符串内部的反斜杠,以确保 $
标记将按原样传递给 n
spi_prepare
,而不会被 Tcl 变量替换。
subtransaction
command
command
中包含的 Tcl 脚本在 SQL 子事务中执行。如果脚本返回错误,则在将错误返回到周围的 Tcl 代码之前,整个子事务将被回滚。有关更多详细信息和示例,请参见第 42.9 节。
quote
string
将给定字符串中所有出现的单引号和反斜杠字符加倍。这可以安全地引用要插入到提供给 spi_exec
或 spi_prepare
的 SQL 命令中的字符串。例如,考虑一个 SQL 命令字符串,如
"SELECT '$val' AS ret"
其中 Tcl 变量 val
实际上包含 doesn't
。这将导致最终的命令字符串
SELECT 'doesn't' AS ret
这将在 spi_exec
或 spi_prepare
期间导致解析错误。为了正常工作,提交的命令应包含
SELECT 'doesn''t' AS ret
可以在 PL/Tcl 中使用以下方法形成:
"SELECT '[ quote $val ]' AS ret"
spi_execp
的一个优点是您不必像这样引用参数值,因为参数永远不会作为 SQL 命令字符串的一部分进行解析。
elog
level
msg
发出日志或错误消息。可能的级别为 DEBUG
、LOG
、INFO
、NOTICE
、WARNING
、ERROR
和 FATAL
。ERROR
引发错误条件;如果周围的 Tcl 代码未捕获此错误,则该错误会传播到调用查询,导致当前事务或子事务被中止。这与 Tcl error
命令的效果相同。FATAL
会中止事务并导致当前会话关闭。(可能没有充分的理由在 PL/Tcl 函数中使用此错误级别,但为了完整性而提供。)其他级别仅生成具有不同优先级级别的消息。是否将特定优先级的消息报告给客户端、写入服务器日志或两者都由 log_min_messages 和 client_min_messages 配置变量控制。有关更多信息,请参见第 19 章和第 42.8 节。
如果您在文档中发现任何不正确、与您使用特定功能的体验不符或需要进一步澄清的地方,请使用此表格报告文档问题。