1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>SPI_execp</title>
<link rel="stylesheet" href="stylesheet.css" type="text/css">
<link rev="made" href="pgsql-docs@postgresql.org">
<meta name="generator" content="DocBook XSL Stylesheets V1.70.0">
<link rel="start" href="index.html" title="PostgreSQL 8.1.4 Documentation">
<link rel="up" href="spi.html#spi-interface" title="40.1.Interface Functions">
<link rel="prev" href="spi-spi-execute-plan.html" title="SPI_execute_plan">
<link rel="next" href="spi-spi-cursor-open.html" title="SPI_cursor_open">
<link rel="copyright" href="ln-legalnotice.html" title="Legal Notice">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en">
<a name="spi-spi-execp"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2>Name</h2>
<p>SPI_execp — execute a plan in read/write mode</p>
</div>
<a name="id736356"></a><div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">int SPI_execp(void * <em class="parameter"><code>plan</code></em>, Datum * <em class="parameter"><code>values</code></em>, const char * <em class="parameter"><code>nulls</code></em>, long <em class="parameter"><code>count</code></em>)</pre>
</div>
<div class="refsect1" lang="en">
<a name="id736395"></a><h2>Description</h2>
<p> <code class="function">SPI_execp</code> is the same as
<code class="function">SPI_execute_plan</code>, with the latter's
<em class="parameter"><code>read_only</code></em> parameter always taken as
<code class="literal">false</code>.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id736429"></a><h2>Arguments</h2>
<div class="variablelist"><dl>
<dt><span class="term"><code class="literal">void * <em class="parameter"><code>plan</code></em></code></span></dt>
<dd><p> execution plan (returned by <code class="function">SPI_prepare</code>)
</p></dd>
<dt><span class="term"><code class="literal">Datum * <em class="parameter"><code>values</code></em></code></span></dt>
<dd><p> An array of actual parameter values. Must have same length as the
plan's number of arguments.
</p></dd>
<dt><span class="term"><code class="literal">const char * <em class="parameter"><code>nulls</code></em></code></span></dt>
<dd>
<p> An array describing which parameters are null. Must have same length as
the plan's number of arguments.
<code class="literal">n</code> indicates a null value (entry in
<em class="parameter"><code>values</code></em> will be ignored); a space indicates a
nonnull value (entry in <em class="parameter"><code>values</code></em> is valid).
</p>
<p> If <em class="parameter"><code>nulls</code></em> is <code class="symbol">NULL</code> then
<code class="function">SPI_execp</code> assumes that no parameters are
null.
</p>
</dd>
<dt><span class="term"><code class="literal">long <em class="parameter"><code>count</code></em></code></span></dt>
<dd><p> maximum number of rows to process or return
</p></dd>
</dl></div>
</div>
<div class="refsect1" lang="en">
<a name="id736555"></a><h2>Return Value</h2>
<p> See <code class="function">SPI_execute_plan</code>.
</p>
<p> <code class="varname">SPI_processed</code> and
<code class="varname">SPI_tuptable</code> are set as in
<code class="function">SPI_execute</code> if successful.
</p>
</div>
</div></body>
</html>
|