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

   1 '\" t
   2 .\"     Title: SPI_freetuptable
   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_FREETUPTABLE" "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_freetuptable \- free a row set created by \fBSPI_execute\fR or a similar function
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 void SPI_freetuptable(SPITupleTable * \fItuptable\fR)
  36 .fi
  37 .SH "DESCRIPTION"
  38 .PP
  39 \fBSPI_freetuptable\fR
  40 frees a row set created by a prior SPI command execution function, such as
  41 \fBSPI_execute\fR\&. Therefore, this function is often called with the global variable
  42 \fISPI_tuptable\fR
  43 as argument\&.
  44 .PP
  45 This function is useful if an SPI\-using C function needs to execute multiple commands and does not want to keep the results of earlier commands around until it ends\&. Note that any unfreed row sets will be freed anyway at
  46 \fBSPI_finish\fR\&. Also, if a subtransaction is started and then aborted within execution of an SPI\-using C function, SPI automatically frees any row sets created while the subtransaction was running\&.
  47 .PP
  48 Beginning in
  49 PostgreSQL
  50 9\&.3,
  51 \fBSPI_freetuptable\fR
  52 contains guard logic to protect against duplicate deletion requests for the same row set\&. In previous releases, duplicate deletions would lead to crashes\&.
  53 .SH "ARGUMENTS"
  54 .PP
  55 SPITupleTable * \fItuptable\fR
  56 .RS 4
  57 pointer to row set to free, or NULL to do nothing
  58 .RE