受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: devel

SPI_modifytuple

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

Synopsis

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的数组,描述哪些新值为空值

如果nullsNULL,那么 SPI_modifytuple假定没有新值为空值。否则, 如果对应的新值为非空,nulls数组的每一项都应 该是' ',而如果对应的新值为空值则为'n'(在 后一种情况中,对应的values项中的新值无关紧 要)。注意nulls不是一个文本字符串,只是一个 数组:它不需要一个'\0'终止符。

返回值

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

出错时,SPI_result被设置如下:

SPI_ERROR_ARGUMENT

如果relNULL,或者 rowNULL,或者ncols 小于等于 0,或者colnumNULL, 或者valuesNULL

SPI_ERROR_NOATTRIBUTE

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

SPI_ERROR_UNCONNECTED

SPI 未激活

提交更正

如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。