SPI_modifytuple

Name

SPI_modifytuple -- 通过替换一个给出行的选定的字段创建一行

Synopsis

HeapTuple SPI_modifytuple(Relation rel, HeapTuple row, int ncols,
                          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 数组的每一项都应该是' '，或者如果对应的参数值为空，那么 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里的字段数)