<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>SPI_prepare_cursor</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="spi-spi-prepare.html" title="SPI_prepare" /><link rel="next" href="spi-spi-prepare-params.html" title="SPI_prepare_params" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">SPI_prepare_cursor</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="spi-spi-prepare.html" title="SPI_prepare">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="spi-interface.html" title="47.1. Interface Functions">Up</a></td><th width="60%" align="center">47.1. Interface Functions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 11.5 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="spi-spi-prepare-params.html" title="SPI_prepare_params">Next</a></td></tr></table><hr></hr></div><div class="refentry" id="SPI-SPI-PREPARE-CURSOR"><div class="titlepage"></div><a id="id-1.8.12.8.8.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">SPI_prepare_cursor</span></h2><p>SPI_prepare_cursor — prepare a statement, without executing it yet</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
SPIPlanPtr SPI_prepare_cursor(const char * <em class="parameter"><code>command</code></em>, int <em class="parameter"><code>nargs</code></em>,
Oid * <em class="parameter"><code>argtypes</code></em>, int <em class="parameter"><code>cursorOptions</code></em>)
</pre></div><div class="refsect1" id="id-1.8.12.8.8.5"><h2>Description</h2><p>
<code class="function">SPI_prepare_cursor</code> is identical to
<code class="function">SPI_prepare</code>, except that it also allows specification
of the planner's <span class="quote">“<span class="quote">cursor options</span>”</span> parameter. This is a bit mask
having the values shown in <code class="filename">nodes/parsenodes.h</code>
for the <code class="structfield">options</code> field of <code class="structname">DeclareCursorStmt</code>.
<code class="function">SPI_prepare</code> always takes the cursor options as zero.
</p></div><div class="refsect1" id="id-1.8.12.8.8.6"><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">const char * <em class="parameter"><code>command</code></em></code></span></dt><dd><p>
command string
</p></dd><dt><span class="term"><code class="literal">int <em class="parameter"><code>nargs</code></em></code></span></dt><dd><p>
number of input parameters (<code class="literal">$1</code>, <code class="literal">$2</code>, etc.)
</p></dd><dt><span class="term"><code class="literal">Oid * <em class="parameter"><code>argtypes</code></em></code></span></dt><dd><p>
pointer to an array containing the <acronym class="acronym">OID</acronym>s of
the data types of the parameters
</p></dd><dt><span class="term"><code class="literal">int <em class="parameter"><code>cursorOptions</code></em></code></span></dt><dd><p>
integer bit mask of cursor options; zero produces default behavior
</p></dd></dl></div></div><div class="refsect1" id="id-1.8.12.8.8.7"><h2>Return Value</h2><p>
<code class="function">SPI_prepare_cursor</code> has the same return conventions as
<code class="function">SPI_prepare</code>.
</p></div><div class="refsect1" id="id-1.8.12.8.8.8"><h2>Notes</h2><p>
Useful bits to set in <em class="parameter"><code>cursorOptions</code></em> include
<code class="symbol">CURSOR_OPT_SCROLL</code>,
<code class="symbol">CURSOR_OPT_NO_SCROLL</code>,
<code class="symbol">CURSOR_OPT_FAST_PLAN</code>,
<code class="symbol">CURSOR_OPT_GENERIC_PLAN</code>, and
<code class="symbol">CURSOR_OPT_CUSTOM_PLAN</code>. Note in particular that
<code class="symbol">CURSOR_OPT_HOLD</code> is ignored.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="spi-spi-prepare.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="spi-interface.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="spi-spi-prepare-params.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SPI_prepare </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> SPI_prepare_params</td></tr></table></div></body></html>
