支持的版本:当前 (17) / 16 / 15 / 14 / 13
开发版本:devel
不支持的版本:12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4

SPI_execute_with_args

SPI_execute_with_args — 使用外部参数执行命令

概要

int SPI_execute_with_args(const char *command,
                          int nargs, Oid *argtypes,
                          Datum *values, const char *nulls,
                          bool read_only, long count)

描述

SPI_execute_with_args 执行一个可能包含对外部提供的参数的引用的命令。命令文本将参数引用为 $n,并且调用为每个这样的符号指定数据类型和值。read_onlycount 的解释与 SPI_execute 中的相同。

SPI_execute 相比,此例程的主要优点是,可以将数据值插入到命令中,而无需繁琐的引用/转义,从而大大降低了 SQL 注入攻击的风险。

可以使用 SPI_prepare 后跟 SPI_execute_plan 来获得类似的结果;但是,当使用此函数时,查询计划始终会针对提供的特定参数值进行自定义。对于一次性查询执行,应首选此函数。如果要使用许多不同的参数执行同一命令,则两种方法都可能更快,具体取决于重新规划的成本与自定义计划的优势。

参数

const char * command

命令字符串

int nargs

输入参数的数量 ($1$2 等)

Oid * argtypes

长度为 nargs 的数组,包含OID参数数据类型的 s

Datum * values

长度为 nargs 的数组,包含实际的参数值

const char * nulls

长度为 nargs 的数组,描述哪些参数为空

如果 nullsNULL,则 SPI_execute_with_args 假定没有参数为空。否则,nulls 数组的每个条目应为 ' ' 如果相应的参数值不为空,则为 'n' 如果相应的参数值为空。(在后一种情况下,相应 values 条目中的实际值并不重要。) 请注意,nulls 不是文本字符串,而只是一个数组:它不需要 '\0' 终止符。

bool read_only

对于只读执行,为 true

long count

要返回的最大行数,如果无限制,则为 0

返回值

返回值与 SPI_execute 的返回值相同。

如果成功,则 SPI_processedSPI_tuptable 的设置方式与 SPI_execute 中的相同。

提交更正

如果您发现文档中的任何内容不正确,与您使用特定功能的体验不符或需要进一步澄清,请使用此表单报告文档问题。