↑↓ 选择↵ 打开⌫ 切换范围完整搜索

PG.CENTER 连接 PostgreSQL 文档、百科与生态知识。由 Pigsty 维护。

支持中的版本: 当前版本 (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 / 8.3 / 8.2 / 8.1 / 8.0 / 7.4
历史版本。 PostgreSQL 10 已结束支持。 2022-11-10. 请参阅 当前版本手册.

SPI_modifytuple

SPI_modifytuple — 通过替换给定行的选定字段来创建新行

大纲

HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, int ncols,
                          int * colnum, Datum * values, const char * nulls)

描述

SPI_modifytuple 通过为选定列替换新值、并在其他位置复制原行的列来创建一行新记录。输入行本身不会被修改。新行会在上层执行器上下文中返回。

此函数只能在连接到 SPI 时使用。否则,它会返回 NULL,并将 SPI_result 设为 SPI_ERROR_UNCONNECTED。

参数

Relation rel

仅用作该行的行描述符来源。(传递关系而不是行描述符是个设计缺陷。)

HeapTuple row

要被修改的行

int ncols

要被修改的列数

int * colnum

一个长度为 ncols 的数组,包含了要被修改的列号(列号从 1 开始)

Datum * values

一个长度为 ncols 的数组,包含了指定列的新值

const char * nulls

一个长度为 ncols 的数组,描述哪些新值为空值

如果 nulls 为 NULL,则 SPI_modifytuple 会假定没有新值为空值。否则,如果对应新值非空值,则 nulls 数组中的对应项应为 ' ';如果对应新值为空值,则对应项应为 'n'。(后一种情况下,对应 values 项中的实际值无关紧要。)注意,nulls 不是文本字符串,而只是一个数组,因此不需要 '\0' 终止符。

返回值

修改后的新行,分配在上层执行器上下文中;出错时返回 NULL(错误指示见 SPI_result)

出错时,SPI_result 被设置如下:

SPI_ERROR_ARGUMENT

如果 rel 为 NULL,或者 row 为 NULL,或者 ncols 小于等于 0,或者 colnum 为 NULL,或者 values 为 NULL。

SPI_ERROR_NOATTRIBUTE

如果 colnum 包含一个无效的列号(小于等于 0 或者大于 row 中的列数)。

SPI_ERROR_UNCONNECTED

SPI 未激活

报告文档问题

阅读 上游文档. 反馈更正前请先核对 当前版本手册.