SPI_returntuple

SPI_returntuple — 准备把一个元组返回为一个 Datum

大纲

HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

描述

SPI_returntuple为一个行在上层执行器上下文中 创建一个拷贝,把它以一种行类型Datum的形式返回。被 返回的指针只需要在返回前通过PointerGetDatum 被转换成Datum

该函数只能在连接到SPI时使用。否则,它会返回NULL并将SPI_result 设置为SPI_ERROR_UNCONNECTED

注意这应该被用于声明为要返回组合类型的函数。它不能用于触发器,在 触发器中应使用SPI_copytuple来返回一个被修改的行。

参数

HeapTuple row

要被拷贝的行

TupleDesc rowdesc

行的描述符(对大部分有效的缓存,每次都传递相同的描述符)

返回值

HeapTupleHeader指向拷贝好的行,或者错误时为NULL (参阅SPI_result获取错误指示) 时才返回 NULL