Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

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 的数组,包含OIDs 参数的数据类型

Datum * values

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

const char * nulls

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

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

bool read_only

对于只读执行为 true

long count

要返回的最大行数,或为 0 表示没有限制

返回值

返回值与 SPI_execute 相同。

成功时,SPI_processedSPI_tuptable 会像 SPI_execute 一样设置。