PostgreSQL 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_only
和 count
的解释与 SPI_execute
中相同。
相对于SPI_execute
,这个例程的主要优 点是数据值可以被插入到命令中而无需冗长的引用/转义,并且因此 减少了 SQL 注入攻击的风险。
可以通过在SPI_prepare
后面跟上 SPI_execute_plan
达到相似的结果。但是, 使用这个函数时查询计划总是被定制成提供的指定参数值。对于一次 性的查询执行,这个函数应该更好。如果同样的命令需要用很多不同 的参数执行,两种方法都可能会更快,这取决于重新做规划的代价与 定制计划带来的好处之间的对比。
参数
const char *
command
-
命令字符串
int
nargs
-
输入参数的数量(
$1
、$2
等等)。 Oid *
argtypes
-
一个长度为
nargs
的数组, 包含参数的数据类型的OID Datum *
values
-
一个长度为
nargs
的数组, 包含实际的参数值 const char *
nulls
-
一个长度为
nargs
的数组, 描述哪些参数为空值如果
nulls
为NULL
, 那么SPI_execute_with_args
会假设没有参数 为空值。否则,如果对应的参数值为非空,nulls
数组的每一个项都应该是' '
;如果对应参数值为空,nulls
数组的项应为'n'
(在后 面的情况中,对应的values
项中的值没有 关系)。注意nulls
不是一个文本字符串, 它只是一个数组:它不需要一个' '
终止符。 bool
read_only
-
对只读执行是
true
long
count
-
要返回的最大行数,
0
表示没有限制
返回值
该返回值和SPI_execute
一样。
如果成功SPI_execute
会设置 SPI_processed
和 SPI_tuptable
。