pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
SPI_modifytuple — 通过替换给定行的选定字段来创建新行
HeapTuple SPI_modifytuple(Relationrel, HeapTuplerow, intncols, int *colnum, Datum *values, const char *nulls)
SPI_modifytuple 通过为选定列替换新值、并在其他位 置复制原行的列来创建一行新记录。输入行本身不会被修改。新行会在上层执行 器上下文中返回。
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' 终止符。
修改后的新行,分配在上层执行器上下文中;仅当row 为 NULL 时才返回 NULL
出错时,SPI_result被设置如下:
SPI_ERROR_ARGUMENT如果rel为NULL,或者 row为NULL,或者ncols 小于等于 0,或者colnum为NULL, 或者values为NULL。
SPI_ERROR_NOATTRIBUTE如果colnum包含一个无效的列号(小于等于 0 或者大于 row中的列数)。
译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。