SPI_execute_with_args

支持中的版本：当前版本 (18) / 17 / 16 / 15 / 14

开发中的版本： 19 / 20devel

已结束支持的版本： 13 / 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4

SPI_execute_with_args
上一页	上一级	47.1. 接口函数	起始页	下一页

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 数组中的对应项应为 ' '；如果对应参数值为空值，则对应项应为 'n'。（后一种情况下，对应 values 项中的实际值无关紧要。）注意，nulls 不是文本字符串，而只是一个数组，因此不需要 '\0' 终止符。

bool read_only

true 表示只读执行

long count

要返回的最大行数，或者用 0 表示不限制

返回值

返回值与 SPI_execute 相同。

成功时，SPI_processed 和 SPI_tuptable 的设置方式与 SPI_execute 相同。

上一页	上一级	下一页
SPI_execute_extended	起始页	SPI_prepare

报告文档问题

阅读上游文档. 通过 PostgreSQL 文档反馈表单.