PostgreSQL 16 文档: SPI_execute_with_args

SPI_execute_with_args
上一个	向上	47.1. 接口函数	主页	下一个

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 的数组，描述哪些参数为 null

如果 nulls 为 NULL，则 SPI_execute_with_args 假定没有参数为 null。否则，如果相应参数值为非 null，则 nulls 数组的每个条目应为 ' '；如果相应参数值为 null，则应为 'n'。（在后一种情况下，相应 values 条目中的实际值无关紧要。）请注意，nulls 不是文本字符串，而只是一个数组：它不需要 '\0' 终止符。

bool read_only

true 表示只读执行

long count

要返回的最大行数，或 0 表示无限制

返回值

返回值与 SPI_execute 相同。

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