Mini Shell

'\" t
.\"     Title: SPI_freetuptable
.\"    Author: The PostgreSQL Global Development Group
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 2017-11-06
.\"    Manual: PostgreSQL 9.2.24 Documentation
.\"    Source: PostgreSQL 9.2.24
.\"  Language: English
.\"
.TH "SPI_FREETUPTABLE" "3" "2017-11-06" "PostgreSQL 9.2.24" "PostgreSQL 9.2.24 Documentation"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
SPI_freetuptable \- free a row set created by \fBSPI_execute\fR or a similar function
.\" SPI_freetuptable
.SH "SYNOPSIS"
.sp
.nf
void SPI_freetuptable(SPITupleTable * \fItuptable\fR)
.fi
.SH "DESCRIPTION"
.PP
\fBSPI_freetuptable\fR
frees a row set created by a prior SPI command execution function, such as
\fBSPI_execute\fR\&. Therefore, this function is usually called with the global variable
\fISPI_tupletable\fR
as argument\&.
.PP
This function is useful if a SPI procedure 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
\fBSPI_finish\fR\&.
.SH "ARGUMENTS"
.PP
SPITupleTable * \fItuptable\fR
.RS 4
pointer to row set to free
.RE