2025年9月25日: PostgreSQL 18 发布!
支持的版本: 当前 (18) / 17 / 16 / 15 / 14 / 13
开发版本: devel
不支持的版本: 12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4

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

command string

int nargs

输入参数的数量($1$2 等)

Oid * argtypes

一个长度为 nargs 的数组,包含OID参数的数据类型

Datum * values

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

const char * nulls

一个长度为 nargs 的数组,描述哪些参数为 null

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

bool read_only

只读执行时为 true

long count

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

返回值

返回值与 SPI_execute 相同。

如果成功,SPI_processedSPI_tuptable 的设置与 SPI_execute 中的相同。

提交更正

如果您在文档中发现任何不正确、与您对特定功能的使用体验不符或需要进一步澄清的内容,请使用 此表格 报告文档问题。