Movatterモバイル変換

SPI_returntuple

SPI_returntuple — prepare to return a tuple as a Datum

Synopsis

HeapTupleHeader SPI_returntuple(HeapTuplerow, TupleDescrowdesc)

Description

SPI_returntuple makes a copy of a row in the upper executor context, returning it in the form of a row typeDatum. The returned pointer need only be converted toDatum viaPointerGetDatum before returning.

This function can only be used while connected to SPI. Otherwise, it returns NULL and setsSPI_result toSPI_ERROR_UNCONNECTED.

Note that this should be used for functions that are declared to return composite types. It is not used for triggers; useSPI_copytuple for returning a modified row in a trigger.

Arguments

Return Value

HeapTupleHeader pointing to copied row, orNULL on error (seeSPI_result for an error indication)