受支持版本: 当前版本 (18) / 17 / 16 / 15 / 14
开发版本: 19 / devel
此文档适用于不受支持的 PostgreSQL 版本。
您可能需要查看当前版本的相同页面,或上面列出的其他受支持版本。

SPI_returntuple

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

Synopsis

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