SPI_modifytuple
SPI_modifytuple — 通过替换给定行的选定字段来创建新行
大纲
HeapTuple SPI_modifytuple(Relationrel, HeapTuplerow, intncols, int *colnum, const Datum *values, const char *nulls)
描述
SPI_modifytuple 通过为选定列替换新值、并在其他位置复制原行的列来创建一行新记录。输入行本身不会被修改。新行会在上层执行器上下文中返回。
此函数只能在连接到 SPI 时使用。否则,它会返回 NULL,并将
SPI_result 设为
SPI_ERROR_UNCONNECTED。
参数
Relationrel仅用作该行的行描述符来源。(传递关系而不是行描述符是个设计缺陷。)
HeapTuplerow要被修改的行
intncols要被修改的列数
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_UNCONNECTEDSPI 未激活