<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SPI_modifytuple</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REV="MADE"
HREF="mailto:pgsql-docs@postgresql.org"><LINK
REL="HOME"
TITLE="PostgreSQL 9.3.9 Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Memory Management"
HREF="spi-memory.html"><LINK
REL="PREVIOUS"
TITLE="SPI_returntuple"
HREF="spi-spi-returntuple.html"><LINK
REL="NEXT"
TITLE="SPI_freetuple"
HREF="spi-spi-freetuple.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="stylesheet.css"><META
HTTP-EQUIV="Content-Type"
CONTENT="text/html; charset=ISO-8859-1"><META
NAME="creation"
CONTENT="2015-06-13T20:07:22"></HEAD
><BODY
CLASS="REFENTRY"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="5"
ALIGN="center"
VALIGN="bottom"
><A
HREF="index.html"
>PostgreSQL 9.3.9 Documentation</A
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
TITLE="SPI_returntuple"
HREF="spi-spi-returntuple.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-memory.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="60%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="20%"
ALIGN="right"
VALIGN="top"
><A
TITLE="SPI_freetuple"
HREF="spi-spi-freetuple.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SPI-SPI-MODIFYTUPLE"
></A
>SPI_modifytuple</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN63825"
></A
><H2
>Name</H2
>SPI_modifytuple -- create a row by replacing selected fields of a given row</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN63830"
></A
><H2
>Synopsis</H2
><PRE
CLASS="SYNOPSIS"
>HeapTuple SPI_modifytuple(Relation <TT
CLASS="PARAMETER"
>rel</TT
>, HeapTuple <TT
CLASS="PARAMETER"
>row</TT
>, int <TT
CLASS="PARAMETER"
>ncols</TT
>,
int * <TT
CLASS="PARAMETER"
>colnum</TT
>, Datum * <TT
CLASS="PARAMETER"
>values</TT
>, const char * <TT
CLASS="PARAMETER"
>nulls</TT
>)</PRE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN63838"
></A
><H2
>Description</H2
><P
> <CODE
CLASS="FUNCTION"
>SPI_modifytuple</CODE
> creates a new row by
substituting new values for selected columns, copying the original
row's columns at other positions. The input row is not modified.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN63842"
></A
><H2
>Arguments</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="LITERAL"
>Relation <TT
CLASS="PARAMETER"
>rel</TT
></TT
></DT
><DD
><P
> Used only as the source of the row descriptor for the row.
(Passing a relation rather than a row descriptor is a
misfeature.)
</P
></DD
><DT
><TT
CLASS="LITERAL"
>HeapTuple <TT
CLASS="PARAMETER"
>row</TT
></TT
></DT
><DD
><P
> row to be modified
</P
></DD
><DT
><TT
CLASS="LITERAL"
>int <TT
CLASS="PARAMETER"
>ncols</TT
></TT
></DT
><DD
><P
> number of columns to be changed
</P
></DD
><DT
><TT
CLASS="LITERAL"
>int * <TT
CLASS="PARAMETER"
>colnum</TT
></TT
></DT
><DD
><P
> an array of length <TT
CLASS="PARAMETER"
>ncols</TT
>, containing the numbers
of the columns that are to be changed (column numbers start at 1)
</P
></DD
><DT
><TT
CLASS="LITERAL"
>Datum * <TT
CLASS="PARAMETER"
>values</TT
></TT
></DT
><DD
><P
> an array of length <TT
CLASS="PARAMETER"
>ncols</TT
>, containing the
new values for the specified columns
</P
></DD
><DT
><TT
CLASS="LITERAL"
>const char * <TT
CLASS="PARAMETER"
>nulls</TT
></TT
></DT
><DD
><P
> an array of length <TT
CLASS="PARAMETER"
>ncols</TT
>, describing which
new values are null
</P
><P
> If <TT
CLASS="PARAMETER"
>nulls</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
> then
<CODE
CLASS="FUNCTION"
>SPI_modifytuple</CODE
> assumes that no new values
are null. Otherwise, each entry of the <TT
CLASS="PARAMETER"
>nulls</TT
>
array should be <TT
CLASS="LITERAL"
>' '</TT
> if the corresponding new value is
non-null, or <TT
CLASS="LITERAL"
>'n'</TT
> if the corresponding new value is
null. (In the latter case, the actual value in the corresponding
<TT
CLASS="PARAMETER"
>values</TT
> entry doesn't matter.) Note that
<TT
CLASS="PARAMETER"
>nulls</TT
> is not a text string, just an array: it
does not need a <TT
CLASS="LITERAL"
>'\0'</TT
> terminator.
</P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN63894"
></A
><H2
>Return Value</H2
><P
> new row with modifications, allocated in the upper executor
context; <TT
CLASS="SYMBOL"
>NULL</TT
> only if <TT
CLASS="PARAMETER"
>row</TT
>
is <TT
CLASS="SYMBOL"
>NULL</TT
>
</P
><P
> On error, <TT
CLASS="VARNAME"
>SPI_result</TT
> is set as follows:
<P
></P
></P><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="SYMBOL"
>SPI_ERROR_ARGUMENT</TT
></DT
><DD
><P
> if <TT
CLASS="PARAMETER"
>rel</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
>, or if
<TT
CLASS="PARAMETER"
>row</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
>, or if <TT
CLASS="PARAMETER"
>ncols</TT
>
is less than or equal to 0, or if <TT
CLASS="PARAMETER"
>colnum</TT
> is
<TT
CLASS="SYMBOL"
>NULL</TT
>, or if <TT
CLASS="PARAMETER"
>values</TT
> is <TT
CLASS="SYMBOL"
>NULL</TT
>.
</P
></DD
><DT
><TT
CLASS="SYMBOL"
>SPI_ERROR_NOATTRIBUTE</TT
></DT
><DD
><P
> if <TT
CLASS="PARAMETER"
>colnum</TT
> contains an invalid column number (less
than or equal to 0 or greater than the number of column in
<TT
CLASS="PARAMETER"
>row</TT
>)
</P
></DD
></DL
></DIV
><P>
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="spi-spi-returntuple.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="spi-spi-freetuple.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SPI_returntuple</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="spi-memory.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SPI_freetuple</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
