Unix/Linux Go Back    


CentOS 7.0 - man page for spi_returntuple (centos section 3)

Linux & Unix Commands - Search Man Pages
Man Page or Keyword Search:   man
Select Man Page Set:       apropos Keyword Search (sections above)


SPI_RETURNTUPLE(3)		  PostgreSQL 9.2.7 Documentation	       SPI_RETURNTUPLE(3)

NAME
       SPI_returntuple - prepare to return a tuple as a Datum

SYNOPSIS
       HeapTupleHeader SPI_returntuple(HeapTuple row, TupleDesc rowdesc)

DESCRIPTION
       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.

       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.

ARGUMENTS
       HeapTuple row
	   row to be copied

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

RETURN VALUE
       HeapTupleHeader pointing to copied row; NULL only if row or rowdesc is NULL

PostgreSQL 9.2.7			    2014-02-17			       SPI_RETURNTUPLE(3)
Unix & Linux Commands & Man Pages : ©2000 - 2018 Unix and Linux Forums


All times are GMT -4. The time now is 03:07 AM.