begriffs open source - ai-pg/blob - full-docs/man3/SPI_copytuple.3

   1 '\" t
   2 .\"     Title: SPI_copytuple
   3 .\"    Author: The PostgreSQL Global Development Group
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2025
   6 .\"    Manual: PostgreSQL 18.0 Documentation
   7 .\"    Source: PostgreSQL 18.0
   8 .\"  Language: English
   9 .\"
  10 .TH "SPI_COPYTUPLE" "3" "2025" "PostgreSQL 18.0" "PostgreSQL 18.0 Documentation"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 SPI_copytuple \- make a copy of a row in the upper executor context
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 HeapTuple SPI_copytuple(HeapTuple \fIrow\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_copytuple\fR
  40 makes a copy of a row in the upper executor context\&. This is normally used to return a modified row from a trigger\&. In a function declared to return a composite type, use
  41 \fBSPI_returntuple\fR
  42 instead\&.
  43 .PP
  44 This function can only be used while connected to SPI\&. Otherwise, it returns NULL and sets
  45 \fISPI_result\fR
  46 to
  47 SPI_ERROR_UNCONNECTED\&.
  48 .SH "ARGUMENTS"
  49 .PP
  50 HeapTuple \fIrow\fR
  51 .RS 4
  52 row to be copied
  53 .RE
  54 .SH "RETURN VALUE"
  55 .PP
  56 the copied row, or
  57 NULL
  58 on error (see
  59 \fISPI_result\fR
  60 for an error indication)