支持的版本:当前 (17) / 16 / 15 / 14 / 13
开发版本:devel
不支持的版本:12 / 11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0 / 8.4 / 8.3 / 8.2 / 8.1 / 8.0

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

提交更正

如果您在文档中发现任何不正确、与您使用特定功能的体验不符或需要进一步澄清的内容,请使用此表单报告文档问题。