begriffs open source - ai-pg/blob - full-docs/src/sgml/html/spi-spi-cursor-open-with-args.html

   1 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
   2 <!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_cursor_open_with_args</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-cursor-open.html" title="SPI_cursor_open" /><link rel="next" href="spi-spi-cursor-open-with-paramlist.html" title="SPI_cursor_open_with_paramlist" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">SPI_cursor_open_with_args</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="spi-spi-cursor-open.html" title="SPI_cursor_open">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="spi-interface.html" title="45.1. Interface Functions">Up</a></td><th width="60%" align="center">45.1. Interface Functions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="spi-spi-cursor-open-with-paramlist.html" title="SPI_cursor_open_with_paramlist">Next</a></td></tr></table><hr /></div><div class="refentry" id="SPI-SPI-CURSOR-OPEN-WITH-ARGS"><div class="titlepage"></div><a id="id-1.8.12.8.20.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">SPI_cursor_open_with_args</span></h2><p>SPI_cursor_open_with_args — set up a cursor using a query and parameters</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 Portal SPI_cursor_open_with_args(const char *<em class="parameter"><code>name</code></em>,
   4                                  const char *<em class="parameter"><code>command</code></em>,
   5                                  int <em class="parameter"><code>nargs</code></em>, Oid *<em class="parameter"><code>argtypes</code></em>,
   6                                  Datum *<em class="parameter"><code>values</code></em>, const char *<em class="parameter"><code>nulls</code></em>,
   7                                  bool <em class="parameter"><code>read_only</code></em>, int <em class="parameter"><code>cursorOptions</code></em>)
   8 </pre></div><div class="refsect1" id="id-1.8.12.8.20.5"><h2>Description</h2><p>
   9    <code class="function">SPI_cursor_open_with_args</code> sets up a cursor
  10    (internally, a portal) that will execute the specified query.
  11    Most of the parameters have the same meanings as the corresponding
  12    parameters to <code class="function">SPI_prepare_cursor</code>
  13    and <code class="function">SPI_cursor_open</code>.
  14   </p><p>
  15    For one-time query execution, this function should be preferred
  16    over <code class="function">SPI_prepare_cursor</code> followed by
  17    <code class="function">SPI_cursor_open</code>.
  18    If the same command is to be executed with many different parameters,
  19    either method might be faster, depending on the cost of re-planning
  20    versus the benefit of custom plans.
  21   </p><p>
  22    The passed-in parameter data will be copied into the cursor's portal, so it
  23    can be freed while the cursor still exists.
  24   </p><p>
  25    This function is now deprecated in favor
  26    of <code class="function">SPI_cursor_parse_open</code>, which provides equivalent
  27    functionality using a more modern API for handling query parameters.
  28   </p></div><div class="refsect1" id="id-1.8.12.8.20.6"><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">const char * <em class="parameter"><code>name</code></em></code></span></dt><dd><p>
  29       name for portal, or <code class="symbol">NULL</code> to let the system
  30       select a name
  31      </p></dd><dt><span class="term"><code class="literal">const char * <em class="parameter"><code>command</code></em></code></span></dt><dd><p>
  32       command string
  33      </p></dd><dt><span class="term"><code class="literal">int <em class="parameter"><code>nargs</code></em></code></span></dt><dd><p>
  34       number of input parameters (<code class="literal">$1</code>, <code class="literal">$2</code>, etc.)
  35      </p></dd><dt><span class="term"><code class="literal">Oid * <em class="parameter"><code>argtypes</code></em></code></span></dt><dd><p>
  36       an array of length <em class="parameter"><code>nargs</code></em>, containing the
  37       <acronym class="acronym">OID</acronym>s of the data types of the parameters
  38      </p></dd><dt><span class="term"><code class="literal">Datum * <em class="parameter"><code>values</code></em></code></span></dt><dd><p>
  39       an array of length <em class="parameter"><code>nargs</code></em>, containing the actual
  40       parameter values
  41      </p></dd><dt><span class="term"><code class="literal">const char * <em class="parameter"><code>nulls</code></em></code></span></dt><dd><p>
  42       an array of length <em class="parameter"><code>nargs</code></em>, describing which
  43       parameters are null
  44      </p><p>
  45       If <em class="parameter"><code>nulls</code></em> is <code class="symbol">NULL</code> then
  46       <code class="function">SPI_cursor_open_with_args</code> assumes that no parameters
  47       are null.  Otherwise, each entry of the <em class="parameter"><code>nulls</code></em>
  48       array should be <code class="literal">' '</code> if the corresponding parameter
  49       value is non-null, or <code class="literal">'n'</code> if the corresponding parameter
  50       value is null.  (In the latter case, the actual value in the
  51       corresponding <em class="parameter"><code>values</code></em> entry doesn't matter.)  Note
  52       that <em class="parameter"><code>nulls</code></em> is not a text string, just an array:
  53       it does not need a <code class="literal">'\0'</code> terminator.
  54      </p></dd><dt><span class="term"><code class="literal">bool <em class="parameter"><code>read_only</code></em></code></span></dt><dd><p><code class="literal">true</code> for read-only execution</p></dd><dt><span class="term"><code class="literal">int <em class="parameter"><code>cursorOptions</code></em></code></span></dt><dd><p>
  55       integer bit mask of cursor options; zero produces default behavior
  56      </p></dd></dl></div></div><div class="refsect1" id="id-1.8.12.8.20.7"><h2>Return Value</h2><p>
  57    Pointer to portal containing the cursor.  Note there is no error
  58    return convention; any error will be reported via <code class="function">elog</code>.
  59   </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-cursor-open.html" title="SPI_cursor_open">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="spi-interface.html" title="45.1. Interface Functions">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="spi-spi-cursor-open-with-paramlist.html" title="SPI_cursor_open_with_paramlist">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SPI_cursor_open </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 18.0 Documentation">Home</a></td><td width="40%" align="right" valign="top"> SPI_cursor_open_with_paramlist</td></tr></table></div></body></html>