GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
SPI_RETURNTUPLE(3) PostgreSQL 14.2 Documentation SPI_RETURNTUPLE(3)

SPI_returntuple - prepare to return a tuple as a Datum

HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

SPI_returntuple makes a copy of a row in the upper executor context, returning it in the form of a row type Datum. The returned pointer need only be converted to Datum via PointerGetDatum before returning.

This function can only be used while connected to SPI. Otherwise, it returns NULL and sets SPI_result to SPI_ERROR_UNCONNECTED.

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

HeapTuple row
row to be copied

TupleDesc rowdesc

descriptor for row (pass the same descriptor each time for most effective caching)

HeapTupleHeader pointing to copied row, or NULL on error (see SPI_result for an error indication)
2022 PostgreSQL 14.2

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.