begriffs open source - ai-pg/blob - full-docs/txt/spi-spi-copytuple.txt

   1
   2 SPI_copytuple
   3
   4    SPI_copytuple — make a copy of a row in the upper executor context
   5
   6 Synopsis
   7
   8 HeapTuple SPI_copytuple(HeapTuple row)
   9
  10 Description
  11
  12    SPI_copytuple makes a copy of a row in the upper executor context. This
  13    is normally used to return a modified row from a trigger. In a function
  14    declared to return a composite type, use SPI_returntuple instead.
  15
  16    This function can only be used while connected to SPI. Otherwise, it
  17    returns NULL and sets SPI_result to SPI_ERROR_UNCONNECTED.
  18
  19 Arguments
  20
  21    HeapTuple row
  22           row to be copied
  23
  24 Return Value
  25
  26    the copied row, or NULL on error (see SPI_result for an error
  27    indication)