Postgresql 中文操作指南

SPI_execute_with_args

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)

Description

SPI_execute_with_args 执行可能包含对外部提供参数的引用的命令。命令文本将参数称为 $_n_ ，并且调用为每个此类符号指定数据类型和值。 read_only 和 count 的解释与 SPI_execute 中相同。

与 SPI_execute 相比，此例程的主要优势在于可以在不进行繁琐的引用/转义的情况下将数据值插入到命令中，从而大大降低了 SQL 注入攻击的风险。

可以使用 SPI_prepare 后跟 SPI_execute_plan 来实现类似的结果；但是，在使用此函数时，查询计划始终根据提供的特定参数值进行定制。对于一次性查询执行，此函数应优先。如果要使用许多不同的参数执行相同的命令，则任一方法都可能更快，具体取决于重新规划的成本与自定义计划的好处的比较。

Arguments

  • const char * _command_

    • command string

  • int _nargs_

    • 输入参数数（ $1 、 $2 等）

  • Oid * _argtypes_

    • 长度为 nargs 的数组，包含参数的数据类型的 OID

  • Datum * _values_

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

  • const char * _nulls_

    • 长度为 nargs 的数组，描述哪些参数为 null

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

  • bool _read_only_

    • true for read-only execution

  • long _count_

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

Return Value

返回值与 SPI_execute 相同。

如果成功，则 SPI_processed 和 SPI_tuptable 与 SPI_execute 中的设置相同。