gooderp18绿色标准版
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

60 rindas
7.0KB

  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_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 V1.79.1" /><link rel="prev" href="spi-spi-exec.html" title="SPI_exec" /><link rel="next" href="spi-spi-prepare.html" title="SPI_prepare" /></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_execute_with_args</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="46.1. Interface Functions">Up</a></td><th width="60%" align="center">46.1. Interface Functions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 12.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="spi-spi-prepare.html" title="SPI_prepare">Next</a></td></tr></table><hr></hr></div><div class="refentry" id="SPI-SPI-EXECUTE-WITH-ARGS"><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_with_args</span></h2><p>SPI_execute_with_args — execute a command with out-of-line parameters</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
  3. int SPI_execute_with_args(const char *<em class="parameter"><code>command</code></em>,
  4. int <em class="parameter"><code>nargs</code></em>, Oid *<em class="parameter"><code>argtypes</code></em>,
  5. Datum *<em class="parameter"><code>values</code></em>, const char *<em class="parameter"><code>nulls</code></em>,
  6. bool <em class="parameter"><code>read_only</code></em>, long <em class="parameter"><code>count</code></em>)
  7. </pre></div><div class="refsect1" id="id-1.8.12.8.6.5"><h2>Description</h2><p>
  8. <code class="function">SPI_execute_with_args</code> executes a command that might
  9. include references to externally supplied parameters. The command text
  10. refers to a parameter as <code class="literal">$<em class="replaceable"><code>n</code></em></code>, and
  11. the call specifies data types and values for each such symbol.
  12. <em class="parameter"><code>read_only</code></em> and <em class="parameter"><code>count</code></em> have
  13. the same interpretation as in <code class="function">SPI_execute</code>.
  14. </p><p>
  15. The main advantage of this routine compared to
  16. <code class="function">SPI_execute</code> is that data values can be inserted
  17. into the command without tedious quoting/escaping, and thus with much
  18. less risk of SQL-injection attacks.
  19. </p><p>
  20. Similar results can be achieved with <code class="function">SPI_prepare</code> followed by
  21. <code class="function">SPI_execute_plan</code>; however, when using this function
  22. the query plan is always customized to the specific parameter values
  23. provided.
  24. For one-time query execution, this function should be preferred.
  25. If the same command is to be executed with many different parameters,
  26. either method might be faster, depending on the cost of re-planning
  27. versus the benefit of custom plans.
  28. </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>
  29. command string
  30. </p></dd><dt><span class="term"><code class="literal">int <em class="parameter"><code>nargs</code></em></code></span></dt><dd><p>
  31. number of input parameters (<code class="literal">$1</code>, <code class="literal">$2</code>, etc.)
  32. </p></dd><dt><span class="term"><code class="literal">Oid * <em class="parameter"><code>argtypes</code></em></code></span></dt><dd><p>
  33. an array of length <em class="parameter"><code>nargs</code></em>, containing the
  34. <acronym class="acronym">OID</acronym>s of the data types of the parameters
  35. </p></dd><dt><span class="term"><code class="literal">Datum * <em class="parameter"><code>values</code></em></code></span></dt><dd><p>
  36. an array of length <em class="parameter"><code>nargs</code></em>, containing the actual
  37. parameter values
  38. </p></dd><dt><span class="term"><code class="literal">const char * <em class="parameter"><code>nulls</code></em></code></span></dt><dd><p>
  39. an array of length <em class="parameter"><code>nargs</code></em>, describing which
  40. parameters are null
  41. </p><p>
  42. If <em class="parameter"><code>nulls</code></em> is <code class="symbol">NULL</code> then
  43. <code class="function">SPI_execute_with_args</code> assumes that no parameters
  44. are null. Otherwise, each entry of the <em class="parameter"><code>nulls</code></em>
  45. array should be <code class="literal">' '</code> if the corresponding parameter
  46. value is non-null, or <code class="literal">'n'</code> if the corresponding parameter
  47. value is null. (In the latter case, the actual value in the
  48. corresponding <em class="parameter"><code>values</code></em> entry doesn't matter.) Note
  49. that <em class="parameter"><code>nulls</code></em> is not a text string, just an array:
  50. it does not need a <code class="literal">'\0'</code> terminator.
  51. </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">long <em class="parameter"><code>count</code></em></code></span></dt><dd><p>
  52. maximum number of rows to return,
  53. or <code class="literal">0</code> for no limit
  54. </p></dd></dl></div></div><div class="refsect1" id="id-1.8.12.8.6.7"><h2>Return Value</h2><p>
  55. The return value is the same as for <code class="function">SPI_execute</code>.
  56. </p><p>
  57. <code class="varname">SPI_processed</code> and
  58. <code class="varname">SPI_tuptable</code> are set as in
  59. <code class="function">SPI_execute</code> if successful.
  60. </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">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.html">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">Home</a></td><td width="40%" align="right" valign="top"> SPI_prepare</td></tr></table></div></body></html>
上海开阖软件有限公司 沪ICP备12045867号-1