begriffs open source - ai-pg/blob - full-docs/html/ecpg-sql-open.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>OPEN</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="ecpg-sql-get-descriptor.html" title="GET DESCRIPTOR" /><link rel="next" href="ecpg-sql-prepare.html" title="PREPARE" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">OPEN</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="ecpg-sql-get-descriptor.html" title="GET DESCRIPTOR">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="ecpg-sql-commands.html" title="34.14. Embedded SQL Commands">Up</a></td><th width="60%" align="center">34.14. Embedded SQL Commands</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="ecpg-sql-prepare.html" title="PREPARE">Next</a></td></tr></table><hr /></div><div class="refentry" id="ECPG-SQL-OPEN"><div class="titlepage"></div><div class="refnamediv"><h2>OPEN</h2><p>OPEN — open a dynamic cursor</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
   3 OPEN <em class="replaceable"><code>cursor_name</code></em>
   4 OPEN <em class="replaceable"><code>cursor_name</code></em> USING <em class="replaceable"><code>value</code></em> [, ... ]
   5 OPEN <em class="replaceable"><code>cursor_name</code></em> USING SQL DESCRIPTOR <em class="replaceable"><code>descriptor_name</code></em>
   6 </pre></div><div class="refsect1" id="id-1.7.5.20.12.3"><h2>Description</h2><p>
   7      <code class="command">OPEN</code> opens a cursor and optionally binds
   8      actual values to the placeholders in the cursor's declaration.
   9      The cursor must previously have been declared with
  10      the <code class="command">DECLARE</code> command.  The execution
  11      of <code class="command">OPEN</code> causes the query to start executing on
  12      the server.
  13     </p></div><div class="refsect1" id="id-1.7.5.20.12.4"><h2>Parameters</h2><div class="variablelist"><dl class="variablelist"><dt id="ECPG-SQL-OPEN-CURSOR-NAME"><span class="term"><em class="replaceable"><code>cursor_name</code></em></span> <a href="#ECPG-SQL-OPEN-CURSOR-NAME" class="id_link">#</a></dt><dd><p>
  14         The name of the cursor to be opened.  This can be an SQL
  15         identifier or a host variable.
  16        </p></dd><dt id="ECPG-SQL-OPEN-VALUE"><span class="term"><em class="replaceable"><code>value</code></em></span> <a href="#ECPG-SQL-OPEN-VALUE" class="id_link">#</a></dt><dd><p>
  17         A value to be bound to a placeholder in the cursor.  This can
  18         be an SQL constant, a host variable, or a host variable with
  19         indicator.
  20        </p></dd><dt id="ECPG-SQL-OPEN-DESCRIPTOR-NAME"><span class="term"><em class="replaceable"><code>descriptor_name</code></em></span> <a href="#ECPG-SQL-OPEN-DESCRIPTOR-NAME" class="id_link">#</a></dt><dd><p>
  21         The name of a descriptor containing values to be bound to the
  22         placeholders in the cursor.  This can be an SQL identifier or
  23         a host variable.
  24        </p></dd></dl></div></div><div class="refsect1" id="id-1.7.5.20.12.5"><h2>Examples</h2><pre class="programlisting">
  25 EXEC SQL OPEN a;
  26 EXEC SQL OPEN d USING 1, 'test';
  27 EXEC SQL OPEN c1 USING SQL DESCRIPTOR mydesc;
  28 EXEC SQL OPEN :curname1;
  29 </pre></div><div class="refsect1" id="id-1.7.5.20.12.6"><h2>Compatibility</h2><p>
  30      <code class="command">OPEN</code> is specified in the SQL standard.
  31     </p></div><div class="refsect1" id="id-1.7.5.20.12.7"><h2>See Also</h2><span class="simplelist"><a class="xref" href="ecpg-sql-declare.html" title="DECLARE">DECLARE</a>, <a class="xref" href="sql-close.html" title="CLOSE"><span class="refentrytitle">CLOSE</span></a></span></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ecpg-sql-get-descriptor.html" title="GET DESCRIPTOR">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ecpg-sql-commands.html" title="34.14. Embedded SQL Commands">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ecpg-sql-prepare.html" title="PREPARE">Next</a></td></tr><tr><td width="40%" align="left" valign="top">GET DESCRIPTOR </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"> PREPARE</td></tr></table></div></body></html>