begriffs open source - ai-pg/blob - full-docs/src/sgml/html/spi-spi-execute-extended.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_execute_extended</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-exec.html" title="SPI_exec" /><link rel="next" href="spi-spi-execute-with-args.html" title="SPI_execute_with_args" /></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_execute_extended</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="spi-spi-exec.html" title="SPI_exec">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-execute-with-args.html" title="SPI_execute_with_args">Next</a></td></tr></table><hr /></div><div class="refentry" id="SPI-SPI-EXECUTE-EXTENDED"><div class="titlepage"></div><a id="id-1.8.12.8.6.1" class="indexterm"></a><div class="refnamediv"><h2><span class="refentrytitle">SPI_execute_extended</span></h2><p>SPI_execute_extended — execute a command with out-of-line parameters</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 int SPI_execute_extended(const char *<em class="parameter"><code>command</code></em>,
   4                          const SPIExecuteOptions * <em class="parameter"><code>options</code></em>)
   5 </pre></div><div class="refsect1" id="id-1.8.12.8.6.5"><h2>Description</h2><p>
   6    <code class="function">SPI_execute_extended</code> executes a command that might
   7    include references to externally supplied parameters.  The command text
   8    refers to a parameter as <code class="literal">$<em class="replaceable"><code>n</code></em></code>,
   9    and the <em class="parameter"><code>options-&gt;params</code></em> object (if supplied)
  10    provides values and type information for each such symbol.
  11    Various execution options can be specified
  12    in the <em class="parameter"><code>options</code></em> struct, too.
  13   </p><p>
  14    The <em class="parameter"><code>options-&gt;params</code></em> object should normally
  15    mark each parameter with the <code class="literal">PARAM_FLAG_CONST</code> flag,
  16    since a one-shot plan is always used for the query.
  17   </p><p>
  18    If <em class="parameter"><code>options-&gt;dest</code></em> is not NULL, then result
  19    tuples are passed to that object as they are generated by the executor,
  20    instead of being accumulated in <code class="varname">SPI_tuptable</code>.  Using
  21    a caller-supplied <code class="literal">DestReceiver</code> object is particularly
  22    helpful for queries that might generate many tuples, since the data can
  23    be processed on-the-fly instead of being accumulated in memory.
  24   </p></div><div class="refsect1" id="id-1.8.12.8.6.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>
  25       command string
  26      </p></dd><dt><span class="term"><code class="literal">const SPIExecuteOptions * <em class="parameter"><code>options</code></em></code></span></dt><dd><p>
  27       struct containing optional arguments
  28      </p></dd></dl></div><p>
  29    Callers should always zero out the entire <em class="parameter"><code>options</code></em>
  30    struct, then fill whichever fields they want to set.  This ensures forward
  31    compatibility of code, since any fields that are added to the struct in
  32    future will be defined to behave backwards-compatibly if they are zero.
  33    The currently available <em class="parameter"><code>options</code></em> fields are:
  34   </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><code class="literal">ParamListInfo <em class="parameter"><code>params</code></em></code></span></dt><dd><p>
  35       data structure containing query parameter types and values; NULL if none
  36      </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">bool <em class="parameter"><code>allow_nonatomic</code></em></code></span></dt><dd><p>
  37       <code class="literal">true</code> allows non-atomic execution of CALL and DO
  38       statements (but this field is ignored unless
  39       the <code class="symbol">SPI_OPT_NONATOMIC</code> flag was passed
  40       to <code class="function">SPI_connect_ext</code>)
  41      </p></dd><dt><span class="term"><code class="literal">bool <em class="parameter"><code>must_return_tuples</code></em></code></span></dt><dd><p>
  42       if <code class="literal">true</code>, raise error if the query is not of a kind
  43       that returns tuples (this does not forbid the case where it happens to
  44       return zero tuples)
  45      </p></dd><dt><span class="term"><code class="literal">uint64 <em class="parameter"><code>tcount</code></em></code></span></dt><dd><p>
  46       maximum number of rows to return,
  47       or <code class="literal">0</code> for no limit
  48      </p></dd><dt><span class="term"><code class="literal">DestReceiver * <em class="parameter"><code>dest</code></em></code></span></dt><dd><p>
  49       <code class="literal">DestReceiver</code> object that will receive any tuples
  50       emitted by the query; if NULL, result tuples are accumulated into
  51       a <code class="varname">SPI_tuptable</code> structure, as
  52       in <code class="function">SPI_execute</code>
  53      </p></dd><dt><span class="term"><code class="literal">ResourceOwner <em class="parameter"><code>owner</code></em></code></span></dt><dd><p>
  54       This field is present for consistency
  55       with <code class="function">SPI_execute_plan_extended</code>, but it is
  56       ignored, since the plan used
  57       by <code class="function">SPI_execute_extended</code> is never saved.
  58      </p></dd></dl></div></div><div class="refsect1" id="id-1.8.12.8.6.7"><h2>Return Value</h2><p>
  59    The return value is the same as for <code class="function">SPI_execute</code>.
  60   </p><p>
  61    When <em class="parameter"><code>options-&gt;dest</code></em> is NULL,
  62    <code class="varname">SPI_processed</code> and
  63    <code class="varname">SPI_tuptable</code> are set as in
  64    <code class="function">SPI_execute</code>.
  65    When <em class="parameter"><code>options-&gt;dest</code></em> is not NULL,
  66    <code class="varname">SPI_processed</code> is set to zero and
  67    <code class="varname">SPI_tuptable</code> is set to NULL.  If a tuple count
  68    is required, the caller's <code class="literal">DestReceiver</code> object must
  69    calculate it.
  70   </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-exec.html" title="SPI_exec">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-execute-with-args.html" title="SPI_execute_with_args">Next</a></td></tr><tr><td width="40%" align="left" valign="top">SPI_exec </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_execute_with_args</td></tr></table></div></body></html>