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不是活跃状态