SPI_execute_with_args

Name

SPI_execute_with_args -- 执行一个带有外联参数的命令

Synopsis

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_execute_plan的SPI_prepare 达到；不过，当使用这个函数时，该查询规划总是自定义为提供的特定的参数值。 对于一次性查询执行，这个函数应该优先执行。如果用许多不同的参数执行相同的命令， 哪种方法可能会更快，取决于重新规划的开销与自定义规划的好处的对比。

参数

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不是文本字符串，只是一个数组： 它不需要'\0'终止符。

bool read_only

true用于只读的执行

long count

返回的最大行数，或者没有限制时为0

返回值

返回值和SPI_execute相同。

如果成功，SPI_processed和SPI_tuptable 和在SPI_execute中一样设置。