doc-exports/docs/dws/dev/dws_04_0556.html
Lu, Huayi e6fa411af0 DWS DEV 830.201 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: Lu, Huayi <luhuayi@huawei.com>
Co-committed-by: Lu, Huayi <luhuayi@huawei.com>
2024-05-16 07:24:04 +00:00

988 lines
96 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="EN-US_TOPIC_0000001188163774"></a><a name="EN-US_TOPIC_0000001188163774"></a>
<h1 class="topictitle1">DBMS_SQL</h1>
<div id="body1551942823551"><div class="section" id="EN-US_TOPIC_0000001188163774__section17922102013106"><h4 class="sectiontitle">Related Interfaces</h4><p id="EN-US_TOPIC_0000001188163774__p1026317138113"><a href="#EN-US_TOPIC_0000001188163774__table11636114145319">Table 1</a> lists interfaces supported by the <strong id="EN-US_TOPIC_0000001188163774__b634041125410">DBMS_SQL</strong> package.</p>
</div>
<div class="tablenoborder"><a name="EN-US_TOPIC_0000001188163774__table11636114145319"></a><a name="table11636114145319"></a><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table11636114145319" frame="border" border="1" rules="all"><caption><b>Table 1 </b>DBMS_SQL</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row136371245536"><th align="left" class="cellrowborder" valign="top" width="55.06999999999999%" id="mcps1.3.2.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p76374415318">API</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.93%" id="mcps1.3.2.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p46371245539">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row88036383342"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1336474915574"><a href="#EN-US_TOPIC_0000001188163774__li1531162015334">DBMS_SQL.OPEN_CURSOR</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p172071957163417">Opens a cursor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row19637114165312"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1982515462548"><a href="#EN-US_TOPIC_0000001188163774__li156795412510">DBMS_SQL.CLOSE_CURSOR</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1093695512571">Closes an open cursor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row92244253237"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p13196455162316"><a href="#EN-US_TOPIC_0000001188163774__li2228125392012">DBMS_SQL.PARSE</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p67847152414">Transmits a group of SQL statements to a cursor. Currently, only the <strong id="EN-US_TOPIC_0000001188163774__b20696124445711">SELECT</strong> statement is supported.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row17555112918238"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p205551329102313"><a href="#EN-US_TOPIC_0000001188163774__li55721712815">DBMS_SQL.EXECUTE</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p10555329152312">Performs a set of dynamically defined operations on the cursor.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row477818911234"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p198812176247"><a href="#EN-US_TOPIC_0000001188163774__li126241517289">DBMS_SQL.FETCHE_ROWS</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p88283468541">Reads a row of cursor data.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row19251842114013"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p19315153712515"><a href="#EN-US_TOPIC_0000001188163774__li93441630193318">DBMS_SQL.DEFINE_COLUMN</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p138269460540">Dynamically defines a column.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row11387202613320"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p155811500176"><a href="#EN-US_TOPIC_0000001188163774__li15241105533618">DBMS_SQL.DEFINE_COLUMN_CHAR</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p910677541">Dynamically defines a column of the CHAR type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row374744118313"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p788964691819"><a href="#EN-US_TOPIC_0000001188163774__li1061171414373">DBMS_SQL.DEFINE_COLUMN_INT</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p113998141045">Dynamically defines a column of the INT type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row11954163719316"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1442571717712"><a href="#EN-US_TOPIC_0000001188163774__li3604521153710">DBMS_SQL.DEFINE_COLUMN_LONG</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1439317199418">Dynamically defines a column of the LONG type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row34971734637"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p108841843013"><a href="#EN-US_TOPIC_0000001188163774__li17405103123711">DBMS_SQL.DEFINE_COLUMN_RAW</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p9827204614549">Dynamically defines a column of the RAW type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row848814291435"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p108001844670"><a href="#EN-US_TOPIC_0000001188163774__li163691742193714">DBMS_SQL.DEFINE_COLUMN_TEXT</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p61920331241">Dynamically defines a column of the TEXT type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row179612036154013"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1931652971"><a href="#EN-US_TOPIC_0000001188163774__li8476651143718">DBMS_SQL.DEFINE_COLUMN_UNKNOWN</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p660314402044">Dynamically defines a column of an unknown type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row2063720415316"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p998618361573"><a href="#EN-US_TOPIC_0000001188163774__li182631611152817">DBMS_SQL.COLUMN_VALUE</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p159511901571">Reads a dynamically defined column value.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1763710416539"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p829561010345"><a href="#EN-US_TOPIC_0000001188163774__li55491765289">DBMS_SQL.COLUMN_VALUE_CHAR</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p582519462549">Reads a dynamically defined column value of the CHAR type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row36371244533"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1055094283413"><a href="#EN-US_TOPIC_0000001188163774__li169604123012">DBMS_SQL.COLUMN_VALUE_INT</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p6826646105412">Reads a dynamically defined column value of the INT type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row263744165316"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p14771455163416"><a href="#EN-US_TOPIC_0000001188163774__li9209325173117">DBMS_SQL.COLUMN_VALUE_LONG</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p08261946155419">Reads a dynamically defined column value of the LONG type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row11637144155313"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p848612912583"><a href="#EN-US_TOPIC_0000001188163774__li1644815212328">DBMS_SQL.COLUMN_VALUE_RAW</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p682684611544">Reads a dynamically defined column value of the RAW type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row863744125314"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p124011623193514"><a href="#EN-US_TOPIC_0000001188163774__li5561542153219">DBMS_SQL.COLUMN_VALUE_TEXT</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p158261146175420">Reads a dynamically defined column value of the TEXT type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row16372425318"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p637175105810"><a href="#EN-US_TOPIC_0000001188163774__li13946783337">DBMS_SQL.COLUMN_VALUE_UNKNOWN</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1482614625417">Reads a dynamically defined column value of an unknown type.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row14638184135315"><td class="cellrowborder" valign="top" width="55.06999999999999%" headers="mcps1.3.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p10445184617019"><a href="#EN-US_TOPIC_0000001188163774__li17449205852910">DBMS_SQL.IS_OPEN</a></p>
</td>
<td class="cellrowborder" valign="top" width="44.93%" headers="mcps1.3.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p8166163011116">Checks whether a cursor is opened.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="EN-US_TOPIC_0000001188163774__note648394593311"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="EN-US_TOPIC_0000001188163774__ul273704934618"><li id="EN-US_TOPIC_0000001188163774__li17371249154611">You are advised to use <strong id="EN-US_TOPIC_0000001188163774__b176201359172919">dbms_sql.define_column</strong> and <strong id="EN-US_TOPIC_0000001188163774__b11978393017">dbms_sql.column_value</strong> to define columns.</li><li id="EN-US_TOPIC_0000001188163774__li26162118528">If the size of the result set is greater than the value of <strong id="EN-US_TOPIC_0000001188163774__b112621042171912">work_mem</strong>, the result set will be flushed to disk. The value of <strong id="EN-US_TOPIC_0000001188163774__b898164272018">work_mem</strong> must be no greater than 512 MB.</li></ul>
</div></div>
<ul id="EN-US_TOPIC_0000001188163774__ul13112201331"><li id="EN-US_TOPIC_0000001188163774__li1531162015334"><a name="EN-US_TOPIC_0000001188163774__li1531162015334"></a><a name="li1531162015334"></a>DBMS_SQL.OPEN_CURSOR<p id="EN-US_TOPIC_0000001188163774__p1518916140523"><a name="EN-US_TOPIC_0000001188163774__li1531162015334"></a><a name="li1531162015334"></a>This function opens a cursor and is the prerequisite for the subsequent dbms_sql operations. This function does not transfer any parameter. It automatically generates cursor IDs in an ascending order and returns values to integer variables.</p>
<p id="EN-US_TOPIC_0000001188163774__p146214294565">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b420124752619">DBMS_SQL.OPEN_CURSOR</strong> is:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen136699131847"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">OPEN_CURSOR</span><span class="w"> </span><span class="p">(</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li156795412510"><a name="EN-US_TOPIC_0000001188163774__li156795412510"></a><a name="li156795412510"></a>DBMS_SQL.CLOSE_CURSOR<p id="EN-US_TOPIC_0000001188163774__p3787043638"><a name="EN-US_TOPIC_0000001188163774__li156795412510"></a><a name="li156795412510"></a>This function closes a cursor. It is the end of each dbms_sql operation. If this function is not invoked when the stored procedure ends, the memory is still occupied by the cursor. Therefore, remember to close a cursor when you do not need to use it. If an exception occurs, the stored procedure exits but the cursor is not closed. Therefore, you are advised to include this interface in the exception handling of the stored procedure.</p>
<p id="EN-US_TOPIC_0000001188163774__p421116281234">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1225145816265">DBMS_SQL.CLOSE_CURSOR</strong> is:</p>
<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen1821132862314"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">CLOSE_CURSOR</span><span class="w"> </span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table105061410179" frame="border" border="1" rules="all"><caption><b>Table 2 </b>DBMS_SQL.CLOSE_CURSOR interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row551181419177"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.4.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p1651171418173">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.2.4.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p1151914121716">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row20511914111717"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.4.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p175111417174">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.2.4.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p125171410176">ID of the cursor to be closed</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="EN-US_TOPIC_0000001188163774__ul547155218206"><li id="EN-US_TOPIC_0000001188163774__li2228125392012"><a name="EN-US_TOPIC_0000001188163774__li2228125392012"></a><a name="li2228125392012"></a>DBMS_SQL.PARSE<p id="EN-US_TOPIC_0000001188163774__p11813182252815"><a name="EN-US_TOPIC_0000001188163774__li2228125392012"></a><a name="li2228125392012"></a>This function parses the query statement of a given cursor. The input query statement is executed immediately. Currently, only the <strong id="EN-US_TOPIC_0000001188163774__b06499180330">SELECT</strong> query statement can be parsed. The statement parameters can be transferred only through the TEXT type. The length cannot exceed 1 GB.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p189881527194716">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1549948192710">DBMS_SQL.PARSE</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen1498842719472"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">PARSE</span><span class="w"> </span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">query_string</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">,</span>
<span class="n">label</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">BOOLEAN</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table7984164412224" frame="border" border="1" rules="all"><caption><b>Table 3 </b>DBMS_SQL.PARSE interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row49841944112216"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.1.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p18984124417229">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.1.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p209842440223">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1998454417224"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p9984204414226">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p59841644142218">ID of the cursor whose query statement is parsed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1098411443223"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p20985174415221">query_string</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p11985744152219">Query statements to be parsed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1898564420220"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1198514412221">language_flag</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.1.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p19855442224">Version language number. Currently, only <strong id="EN-US_TOPIC_0000001188163774__b11804185223618">1</strong> is supported.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li55721712815"><a name="EN-US_TOPIC_0000001188163774__li55721712815"></a><a name="li55721712815"></a>DBMS_SQL.EXECUTE<p id="EN-US_TOPIC_0000001188163774__p19540105218284"><a name="EN-US_TOPIC_0000001188163774__li55721712815"></a><a name="li55721712815"></a>This function executes a given cursor. This function receives a cursor ID. The obtained data after is used for subsequent operations. Currently, only the <strong id="EN-US_TOPIC_0000001188163774__b356052383815">SELECT</strong> query statement can be executed.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p1332417100366">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1033519205271">DBMS_SQL.EXECUTE</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen103241510153617"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="k">EXECUTE</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table34211352454" frame="border" border="1" rules="all"><caption><b>Table 4 </b>DBMS_SQL.EXECUTE interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row3428355459"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p17424355450">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p2042123514511">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1442163564510"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p34218351452">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p6420357459">ID of the cursor whose query statement is parsed</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li126241517289"><a name="EN-US_TOPIC_0000001188163774__li126241517289"></a><a name="li126241517289"></a>DBMS_SQL.FETCHE_ROWS<p id="EN-US_TOPIC_0000001188163774__p4314168172910"><a name="EN-US_TOPIC_0000001188163774__li126241517289"></a><a name="li126241517289"></a>This function returns the number of data rows that meet query conditions. Each time the interface is executed, the system obtains a set of new rows until all data is read.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p152503015017">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1049731142711">DBMS_SQL.FETCHE_ROWS</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen182553035018"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">FETCHE_ROWS</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table122351912115210" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DBMS_SQL.FETCH_ROWS interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row7236712125216"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p1723612128523">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p11236141225216">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row4236101216527"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p14236101212525">curosorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1623681215214">ID of the cursor to be executed</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li93441630193318"><a name="EN-US_TOPIC_0000001188163774__li93441630193318"></a><a name="li93441630193318"></a>DBMS_SQL.DEFINE_COLUMN<p id="EN-US_TOPIC_0000001188163774__p1549216589248"><a name="EN-US_TOPIC_0000001188163774__li93441630193318"></a><a name="li93441630193318"></a>This function defines columns returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b188581154114512">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p1231452511384">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1839814219274">DBMS_SQL.DEFINE_COLUMN</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen9314152513810"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">column_ref</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="n">ANYELEMENT</span><span class="p">,</span>
<span class="n">column_size</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">1024</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table62711212164315" frame="border" border="1" rules="all"><caption><b>Table 6 </b>DBMS_SQL.DEFINE_COLUMN interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row62721112204320"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p62721012124317">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.4.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p527213126432">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row8272101212438"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p16988545194310">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p627211294317">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row627231234317"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1327251217437">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p152724124432">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row182726127439"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p172721312154313">column_ref</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p12272181264310">Variable of any type. You can select an appropriate interface to dynamically define columns based on variable types.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row15272012204317"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p2272151213431">column_size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.4.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p52720120435">Length of a defined column</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li15241105533618"><a name="EN-US_TOPIC_0000001188163774__li15241105533618"></a><a name="li15241105533618"></a>DBMS_SQL.DEFINE_COLUMN_CHAR<p id="EN-US_TOPIC_0000001188163774__p1034591103216"><a name="EN-US_TOPIC_0000001188163774__li15241105533618"></a><a name="li15241105533618"></a>This function defines columns of the CHAR type returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b6600172513">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p19311221144417">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b115661052152717">DBMS_SQL.DEFINE_COLUMN_CHAR</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen631172174412"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_CHAR</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">column</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">,</span>
<span class="n">column_size</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table191631422134618" frame="border" border="1" rules="all"><caption><b>Table 7 </b>DBMS_SQL.DEFINE_COLUMN_CHAR interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row151632022174612"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p18163182214464">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.5.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p3163182219464">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1816392234611"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p816312220465">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p9163112220462">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1416314225466"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p316314228461">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p2163122224610">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row91631722104612"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1816382234617">column</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1216322264620">Parameter to be defined</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1516322211469"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p131639225468">column_size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.5.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p9163422184616">Length of a dynamically defined column</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li1061171414373"><a name="EN-US_TOPIC_0000001188163774__li1061171414373"></a><a name="li1061171414373"></a>DBMS_SQL.DEFINE_COLUMN_INT<p id="EN-US_TOPIC_0000001188163774__p12772225133613"><a name="EN-US_TOPIC_0000001188163774__li1061171414373"></a><a name="li1061171414373"></a>This function defines columns of the INT type returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b84581610175912">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p1790218590461">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b42814519282">DBMS_SQL.DEFINE_COLUMN_INT</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen6902125910468"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_INT</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table4844143019471" frame="border" border="1" rules="all"><caption><b>Table 8 </b>DBMS_SQL.DEFINE_COLUMN_INT interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row684523015477"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p16845203013471">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.6.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p68457307472">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row5845193010477"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p9845830114714">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p8845830124715">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row884513011475"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p98451730114715">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.6.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p7845193012479">Position of a dynamically defined column in the query</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li3604521153710"><a name="EN-US_TOPIC_0000001188163774__li3604521153710"></a><a name="li3604521153710"></a>DBMS_SQL.DEFINE_COLUMN_LONG<p id="EN-US_TOPIC_0000001188163774__p11261250153614"><a name="EN-US_TOPIC_0000001188163774__li3604521153710"></a><a name="li3604521153710"></a>This function defines columns of a long type (not LONG) returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b11386153511011">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type. The maximum size of a long column is 1 GB.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p2435175994810">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b184314168285">DBMS_SQL.DEFINE_COLUMN_LONG</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen1343510592482"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_LONG</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table16880142320498" frame="border" border="1" rules="all"><caption><b>Table 9 </b>DBMS_SQL.DEFINE_COLUMN_LONG interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row178811423104911"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p18810238493">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.7.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p8881122320497">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row15881223144913"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p78811233499">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p20882223194919">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row3882152384914"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p188213235494">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.7.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p89131892309">Position of a dynamically defined column in the query</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li17405103123711"><a name="EN-US_TOPIC_0000001188163774__li17405103123711"></a><a name="li17405103123711"></a>DBMS_SQL.DEFINE_COLUMN_RAW<p id="EN-US_TOPIC_0000001188163774__p161863910416"><a name="EN-US_TOPIC_0000001188163774__li17405103123711"></a><a name="li17405103123711"></a>This function defines columns of the RAW type returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b1282615412215">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p75651710175019">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b858363417281">DBMS_SQL.DEFINE_COLUMN_RAW</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen155662010185020"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_RAW</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">column</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="n">BYTEA</span><span class="p">,</span>
<span class="n">column_size</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table1566410115015" frame="border" border="1" rules="all"><caption><b>Table 10 </b>DBMS_SQL.DEFINE_COLUMN_RAW interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row556731065016"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.8.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p17567121012502">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.8.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p1356719104502">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row12567161012503"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p15567121018503">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p16567510135019">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row656711095013"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p6567810125015">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p106523718308">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row19568111016503"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p17568510145017">column</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p4568171010502">Parameter of the RAW type</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1156891014504"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p2568161075018">column_size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.8.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1956815107500">Column length</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li163691742193714"><a name="EN-US_TOPIC_0000001188163774__li163691742193714"></a><a name="li163691742193714"></a>DBMS_SQL.DEFINE_COLUMN_TEXT<p id="EN-US_TOPIC_0000001188163774__p92931919134520"><a name="EN-US_TOPIC_0000001188163774__li163691742193714"></a><a name="li163691742193714"></a>This function defines columns of the TEXT type returned from a given cursor and can be used only for the cursors defined by <strong id="EN-US_TOPIC_0000001188163774__b10748137655">SELECT</strong>. The defined columns are identified by the relative positions in the query list. The data type of the input variable determines the column type.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p04531836514">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b04501644152810">DBMS_SQL.DEFINE_COLUMN_TEXT</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen445343115117"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_CHAR</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">max_size</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table1545320385115" frame="border" border="1" rules="all"><caption><b>Table 11 </b>DBMS_SQL.DEFINE_COLUMN_TEXT interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row74532039518"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.9.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p945418375110">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.9.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p154541139519">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row64548385113"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p14541355117">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p2045413316510">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row144540395111"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1645411345115">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p20734229349">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row34559365115"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1645520315514">max_size</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.9.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p124555318516">Maximum length of the defined TEXT type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li8476651143718"><a name="EN-US_TOPIC_0000001188163774__li8476651143718"></a><a name="li8476651143718"></a>DBMS_SQL.DEFINE_COLUMN_UNKNOWN<p id="EN-US_TOPIC_0000001188163774__p6476451193719"><a name="EN-US_TOPIC_0000001188163774__li8476651143718"></a><a name="li8476651143718"></a>This function processes columns of unknown data types returned from a given cursor and is used only for the system to report an error and exist when the type cannot be identified.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p1999111215538">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1595485482819">DBMS_SQL.DEFINE_COLUMN_UNKNOWN</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen16993124535"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">DEFINE_COLUMN_CHAR</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">column</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">TEXT</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table209981220534" frame="border" border="1" rules="all"><caption><b>Table 12 </b>DBMS_SQL.DEFINE_COLUMN_UNKNOWN interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row9100612165314"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.10.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p17100201225316">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.10.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p6100111212537">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row151006126531"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p410031218532">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1810014129531">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row201001012115313"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p131009129531">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p893915264349">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row14100312115313"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p3100121255315">column</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.10.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p18100101212531">Dynamically defined parameter</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li182631611152817"><a name="EN-US_TOPIC_0000001188163774__li182631611152817"></a><a name="li182631611152817"></a>DBMS_SQL.COLUMN_VALUE<p id="EN-US_TOPIC_0000001188163774__p3960124582914"><a name="EN-US_TOPIC_0000001188163774__li182631611152817"></a><a name="li182631611152817"></a>This function returns the cursor element value specified by a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p3414141565417">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b182625682914">DBMS_SQL.COLUMN_VALUE</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen7414171515419"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">column_value</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="n">ANYELEMENT</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="n">ANYELEMENT</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table14141615165415" frame="border" border="1" rules="all"><caption><b>Table 13 </b>DBMS_SQL.COLUMN_VALUE interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row184144152542"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.11.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p11414115145414">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.11.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p6414131505418">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row141571515413"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p2041551516549">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p541571519544">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row18415191565410"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p741517153547">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p156627310341">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row13415191515419"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1041511515413">column_value</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.11.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p941853510814">Return value of a defined column</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li55491765289"><a name="EN-US_TOPIC_0000001188163774__li55491765289"></a><a name="li55491765289"></a>DBMS_SQL.COLUMN_VALUE_CHAR<p id="EN-US_TOPIC_0000001188163774__p189751256115715"><a name="EN-US_TOPIC_0000001188163774__li55491765289"></a><a name="li55491765289"></a>This function returns the value of the CHAR type in a specified position of a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p15976165695718">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1425016216244">DBMS_SQL.COLUMN_VALUE_CHAR</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen1597635618572"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_CHAR</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">column_value</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">CHARACTER</span><span class="p">,</span>
<span class="n">err_num</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">NUMERIC</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="n">actual_length</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">INTEGER</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">1024</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="n">RECORD</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table2976175612571" frame="border" border="1" rules="all"><caption><b>Table 14 </b>DBMS_SQL.COLUMN_VALUE_CHAR interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row1897612569572"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.12.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p597715645719">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.12.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p119771856165710">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1897755619579"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p2977195619576">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p297711566573">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row99775567571"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p14977165695711">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1977205675711">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row18977256145719"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1844994713017">column_value</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1297815610571">Return value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row34711434402"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p247110341012">err_num</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p147116348015">Error No. It is an output parameter and the argument must be a variable. Currently, the output value is <strong id="EN-US_TOPIC_0000001188163774__b598601210311">1</strong> regardless of the argument.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row473818385010"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p173816381014">actual_length</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.12.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1173818381102">Length of a return value</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li169604123012"><a name="EN-US_TOPIC_0000001188163774__li169604123012"></a><a name="li169604123012"></a>DBMS_SQL.COLUMN_VALUE_INT<div class="p" id="EN-US_TOPIC_0000001188163774__p83235191215"><a name="EN-US_TOPIC_0000001188163774__li169604123012"></a><a name="li169604123012"></a>This function returns the value of the INT type in a specified position of a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS. The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b184317144241">DBMS_SQL.COLUMN_VALUE_INT</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen4323141917119"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_INT</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table1032351912114" frame="border" border="1" rules="all"><caption><b>Table 15 </b>DBMS_SQL.COLUMN_VALUE_INT interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row1032410194120"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.13.2.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p133243191117">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.13.2.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p432421917114">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row63241819819"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.13.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p9324819515">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.13.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p532414193111">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row13324319218"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.13.2.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1632431910119">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.13.2.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p33251719719">Position of a dynamically defined column in the query</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li9209325173117"><a name="EN-US_TOPIC_0000001188163774__li9209325173117"></a><a name="li9209325173117"></a>DBMS_SQL.COLUMN_VALUE_LONG<p id="EN-US_TOPIC_0000001188163774__p784719434216"><a name="EN-US_TOPIC_0000001188163774__li9209325173117"></a><a name="li9209325173117"></a>This function returns the value of a long type (not LONG or BIGINT) in a specified position of a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p6847643429">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b1790062522411">DBMS_SQL.COLUMN_VALUE_LONG</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen1284714431824"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span>
<span class="normal">9</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_LONG</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">length</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">off_set</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">column_value</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">,</span>
<span class="n">actual_length</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">INTEGER</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">1024</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="n">RECORD</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table68481943123" frame="border" border="1" rules="all"><caption><b>Table 16 </b>DBMS_SQL.COLUMN_VALUE_LONG interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row684854310215"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.14.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p1984817431822">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.14.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p6848174316217">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row98488434219"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p78481643420">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1884910439210">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row48491843321"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p208497431325">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p8820205023418">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row461382014518"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p861342016516">length</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1061317201655">Length of a return value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row184914431227"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p24501339558">off_set</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p158499436217">Start position of a return value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row118491643423"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1284910431427">column_value</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1784919431627">Return value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1984914310210"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p7849184320211">actual_length</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.14.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p484911436219">Length of a return value</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li1644815212328"><a name="EN-US_TOPIC_0000001188163774__li1644815212328"></a><a name="li1644815212328"></a>DBMS_SQL.COLUMN_VALUE_RAW<p id="EN-US_TOPIC_0000001188163774__p387713462062"><a name="EN-US_TOPIC_0000001188163774__li1644815212328"></a><a name="li1644815212328"></a>This function returns the value of the RAW type in a specified position of a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p387712461661">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b0862737182413">DBMS_SQL.COLUMN_VALUE_RAW</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen17878104618618"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span>
<span class="normal">7</span>
<span class="normal">8</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_RAW</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">column_value</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="n">BYTEA</span><span class="p">,</span>
<span class="n">err_num</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">NUMERIC</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="n">actual_length</span><span class="w"> </span><span class="k">INOUT</span><span class="w"> </span><span class="nb">INTEGER</span><span class="w"> </span><span class="k">default</span><span class="w"> </span><span class="mi">1024</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="n">RECORD</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table128781461863" frame="border" border="1" rules="all"><caption><b>Table 17 </b>DBMS_SQL.COLUMN_VALUE_RAW interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row68781746766"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.15.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p7879144620614">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.15.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p78794461768">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1987918461061"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p88790460618">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p48791646263">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1687984614618"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p148791462620">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p8243955183411">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row88790462610"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p1487954614617">column_value</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p2880246865">Returned column value</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row18880184616617"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p78801346863">err_num</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p188017469616">Error No. It is an output parameter and the argument must be a variable. Currently, the output value is <strong id="EN-US_TOPIC_0000001188163774__b181932063118">1</strong> regardless of the argument.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row1288014618617"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p198801846664">actual_length</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.15.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1788013464616">Length of a return value. The value longer than this length will be truncated.</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li5561542153219"><a name="EN-US_TOPIC_0000001188163774__li5561542153219"></a><a name="li5561542153219"></a>DBMS_SQL.COLUMN_VALUE_TEXT<p id="EN-US_TOPIC_0000001188163774__p1153113718918"><a name="EN-US_TOPIC_0000001188163774__li5561542153219"></a><a name="li5561542153219"></a>This function returns the value of the TEXT type in a specified position of a cursor and accesses the data obtained by DBMS_SQL.FETCH_ROWS.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p1253112371491">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b11529426112519">DBMS_SQL.COLUMN_VALUE_TEXT</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen15315371396"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_TEXT</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table653283714911" frame="border" border="1" rules="all"><caption><b>Table 18 </b>DBMS_SQL.COLUMN_VALUE_TEXT interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row65326371297"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.16.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p1353318374918">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.16.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p353363710920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row16533203711917"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.16.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p75330373918">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.16.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p1553311371694">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row55332037790"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.16.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p4533837291">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.16.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p158455584344">Position of a dynamically defined column in the query</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li13946783337"><a name="EN-US_TOPIC_0000001188163774__li13946783337"></a><a name="li13946783337"></a>DBMS_SQL.COLUMN_VALUE_UNKNOWN<p id="EN-US_TOPIC_0000001188163774__p1684182101312"><a name="EN-US_TOPIC_0000001188163774__li13946783337"></a><a name="li13946783337"></a>This function returns the value of an unknown type in a specified position of a cursor. This is an error handling interface when the type is not unknown.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p768420281315">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b11205124910259">DBMS_SQL.COLUMN_VALUE_UNKNOWN</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen186854220138"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span>
<span class="normal">5</span>
<span class="normal">6</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">COLUMN_VALUE_UNKNOWN</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="k">position</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
<span class="n">COLUMN_TYPE</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">TEXT</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">TEXT</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table16851925133" frame="border" border="1" rules="all"><caption><b>Table 19 </b>DBMS_SQL.COLUMN_VALUE_UNKNOWN interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row1568514210133"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.17.3.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p368610261319">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.17.3.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p26861211315">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row4686020137"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p106867212139">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p15686182121316">ID of the cursor to be executed</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row168620281318"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p196876219132">position</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p178058103515">Position of a dynamically defined column in the query</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001188163774__row6877159101415"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p18877994149">column_type</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.17.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p987810915146">Returned parameter type</p>
</td>
</tr>
</tbody>
</table>
</div>
</li><li id="EN-US_TOPIC_0000001188163774__li17449205852910"><a name="EN-US_TOPIC_0000001188163774__li17449205852910"></a><a name="li17449205852910"></a>DBMS_SQL.IS_OPEN</li></ul>
<p id="EN-US_TOPIC_0000001188163774__p1315633101420">This function returns the status of a cursor: <strong id="EN-US_TOPIC_0000001188163774__b1060419124111">open</strong>, <strong id="EN-US_TOPIC_0000001188163774__b14356075412">parse</strong>, <strong id="EN-US_TOPIC_0000001188163774__b187516107412">execute</strong>, or <strong id="EN-US_TOPIC_0000001188163774__b5461521184113">define</strong>. The value is <strong id="EN-US_TOPIC_0000001188163774__b165838514425">TRUE</strong>. If the status is unknown, an error is reported. In other cases, the value is <strong id="EN-US_TOPIC_0000001188163774__b16247105124410">FALSE</strong>.</p>
<div class="p" id="EN-US_TOPIC_0000001188163774__p03157333142">The function prototype of <strong id="EN-US_TOPIC_0000001188163774__b148208294261">DBMS_SQL.IS_OPEN</strong> is:<div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__screen131543318147"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">DBMS_SQL</span><span class="p">.</span><span class="n">IS_OPEN</span><span class="p">(</span>
<span class="n">cursorid</span><span class="w"> </span><span class="k">IN</span><span class="w"> </span><span class="nb">INTEGER</span>
<span class="p">)</span>
<span class="k">RETURN</span><span class="w"> </span><span class="nb">BOOLEAN</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001188163774__table16315173311410" frame="border" border="1" rules="all"><caption><b>Table 20 </b>DBMS_SQL.IS_OPEN interface parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000001188163774__row831693321416"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.2.3.1.1"><p id="EN-US_TOPIC_0000001188163774__p153161337146">Parameter Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.8.2.3.1.2"><p id="EN-US_TOPIC_0000001188163774__p9316633181419">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001188163774__row1231673341416"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.2.3.1.1 "><p id="EN-US_TOPIC_0000001188163774__p931603314142">cursorid</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.8.2.3.1.2 "><p id="EN-US_TOPIC_0000001188163774__p731753341417">ID of the cursor to be queried</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="EN-US_TOPIC_0000001188163774__s5d1715f6c42b451c9afaef512eeec772"><h4 class="sectiontitle">Examples</h4><div class="codecoloring" codetype="Sql" id="EN-US_TOPIC_0000001188163774__sa7009ce6d0294bad92d07bd771111342"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal"> 1</span>
<span class="normal"> 2</span>
<span class="normal"> 3</span>
<span class="normal"> 4</span>
<span class="normal"> 5</span>
<span class="normal"> 6</span>
<span class="normal"> 7</span>
<span class="normal"> 8</span>
<span class="normal"> 9</span>
<span class="normal">10</span>
<span class="normal">11</span>
<span class="normal">12</span>
<span class="normal">13</span>
<span class="normal">14</span>
<span class="normal">15</span>
<span class="normal">16</span>
<span class="normal">17</span>
<span class="normal">18</span>
<span class="normal">19</span>
<span class="normal">20</span>
<span class="normal">21</span>
<span class="normal">22</span>
<span class="normal">23</span>
<span class="normal">24</span>
<span class="normal">25</span>
<span class="normal">26</span>
<span class="normal">27</span>
<span class="normal">28</span>
<span class="normal">29</span>
<span class="normal">30</span>
<span class="normal">31</span>
<span class="normal">32</span>
<span class="normal">33</span>
<span class="normal">34</span>
<span class="normal">35</span>
<span class="normal">36</span>
<span class="normal">37</span>
<span class="normal">38</span>
<span class="normal">39</span>
<span class="normal">40</span>
<span class="normal">41</span>
<span class="normal">42</span></pre></div></td><td class="code"><div><pre><span></span><span class="c1">-- Perform operations on RAW data in a stored procedure.</span>
<span class="k">create</span><span class="w"> </span><span class="k">or</span><span class="w"> </span><span class="k">replace</span><span class="w"> </span><span class="k">procedure</span><span class="w"> </span><span class="n">pro_dbms_sql_all_02</span><span class="p">(</span><span class="n">in_raw</span><span class="w"> </span><span class="n">raw</span><span class="p">,</span><span class="n">v_in</span><span class="w"> </span><span class="nb">int</span><span class="p">,</span><span class="n">v_offset</span><span class="w"> </span><span class="nb">int</span><span class="p">)</span>
<span class="k">as</span><span class="w"> </span>
<span class="n">cursorid</span><span class="w"> </span><span class="nb">int</span><span class="p">;</span>
<span class="n">v_id</span><span class="w"> </span><span class="nb">int</span><span class="p">;</span>
<span class="n">v_info</span><span class="w"> </span><span class="n">bytea</span><span class="w"> </span><span class="p">:</span><span class="o">=</span><span class="mi">1</span><span class="p">;</span>
<span class="n">query</span><span class="w"> </span><span class="nb">varchar</span><span class="p">(</span><span class="mi">2000</span><span class="p">);</span>
<span class="n">execute_ret</span><span class="w"> </span><span class="nb">int</span><span class="p">;</span>
<span class="n">define_column_ret_raw</span><span class="w"> </span><span class="n">bytea</span><span class="w"> </span><span class="p">:</span><span class="o">=</span><span class="s1">'1'</span><span class="p">;</span>
<span class="n">define_column_ret</span><span class="w"> </span><span class="nb">int</span><span class="p">;</span>
<span class="k">begin</span>
<span class="k">drop</span><span class="w"> </span><span class="k">table</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">exists</span><span class="w"> </span><span class="n">pro_dbms_sql_all_tb1_02</span><span class="w"> </span><span class="p">;</span>
<span class="k">create</span><span class="w"> </span><span class="k">table</span><span class="w"> </span><span class="n">pro_dbms_sql_all_tb1_02</span><span class="p">(</span><span class="n">a</span><span class="w"> </span><span class="nb">int</span><span class="w"> </span><span class="p">,</span><span class="n">b</span><span class="w"> </span><span class="nb">blob</span><span class="p">);</span>
<span class="k">insert</span><span class="w"> </span><span class="k">into</span><span class="w"> </span><span class="n">pro_dbms_sql_all_tb1_02</span><span class="w"> </span><span class="k">values</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="n">HEXTORAW</span><span class="p">(</span><span class="s1">'DEADBEEE'</span><span class="p">));</span>
<span class="k">insert</span><span class="w"> </span><span class="k">into</span><span class="w"> </span><span class="n">pro_dbms_sql_all_tb1_02</span><span class="w"> </span><span class="k">values</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span><span class="n">in_raw</span><span class="p">);</span>
<span class="n">query</span><span class="w"> </span><span class="p">:</span><span class="o">=</span><span class="w"> </span><span class="s1">'select * from pro_dbms_sql_all_tb1_02 order by 1'</span><span class="p">;</span>
<span class="c1">-- Open a cursor.</span>
<span class="n">cursorid</span><span class="w"> </span><span class="p">:</span><span class="o">=</span><span class="w"> </span><span class="n">dbms_sql</span><span class="p">.</span><span class="n">open_cursor</span><span class="p">();</span>
<span class="c1">-- Compile the cursor.</span>
<span class="n">dbms_sql</span><span class="p">.</span><span class="n">parse</span><span class="p">(</span><span class="n">cursorid</span><span class="p">,</span><span class="w"> </span><span class="n">query</span><span class="p">,</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span>
<span class="c1">-- Define a column.</span>
<span class="n">define_column_ret</span><span class="p">:</span><span class="o">=</span><span class="w"> </span><span class="n">dbms_sql</span><span class="p">.</span><span class="n">define_column</span><span class="p">(</span><span class="n">cursorid</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="n">v_id</span><span class="p">);</span>
<span class="n">define_column_ret_raw</span><span class="p">:</span><span class="o">=</span><span class="w"> </span><span class="n">dbms_sql</span><span class="p">.</span><span class="n">define_column_raw</span><span class="p">(</span><span class="n">cursorid</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="n">v_info</span><span class="p">,</span><span class="mi">10</span><span class="p">);</span>
<span class="c1">-- Execute the cursor.</span>
<span class="n">execute_ret</span><span class="w"> </span><span class="p">:</span><span class="o">=</span><span class="w"> </span><span class="n">dbms_sql</span><span class="p">.</span><span class="k">execute</span><span class="p">(</span><span class="n">cursorid</span><span class="p">);</span>
<span class="n">loop</span><span class="w"> </span>
<span class="n">exit</span><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="p">(</span><span class="n">dbms_sql</span><span class="p">.</span><span class="n">fetch_rows</span><span class="p">(</span><span class="n">cursorid</span><span class="p">)</span><span class="w"> </span><span class="o">&lt;=</span><span class="w"> </span><span class="mi">0</span><span class="p">);</span>
<span class="c1">-- Obtain values.</span>
<span class="n">dbms_sql</span><span class="p">.</span><span class="n">column_value</span><span class="p">(</span><span class="n">cursorid</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="n">v_id</span><span class="p">);</span>
<span class="n">dbms_sql</span><span class="p">.</span><span class="n">column_value_raw</span><span class="p">(</span><span class="n">cursorid</span><span class="p">,</span><span class="mi">2</span><span class="p">,</span><span class="n">v_info</span><span class="p">,</span><span class="n">v_in</span><span class="p">,</span><span class="n">v_offset</span><span class="p">);</span>
<span class="c1">-- Output the result.</span>
<span class="n">dbms_output</span><span class="p">.</span><span class="n">put_line</span><span class="p">(</span><span class="s1">'id:'</span><span class="o">||</span><span class="w"> </span><span class="n">v_id</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="s1">' info:'</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="n">v_info</span><span class="p">);</span>
<span class="k">end</span><span class="w"> </span><span class="n">loop</span><span class="p">;</span>
<span class="c1">-- Close the cursor.</span>
<span class="n">dbms_sql</span><span class="p">.</span><span class="n">close_cursor</span><span class="p">(</span><span class="n">cursorid</span><span class="p">);</span>
<span class="k">end</span><span class="p">;</span>
<span class="o">/</span>
<span class="c1">-- Invoke the stored procedure.</span>
<span class="k">call</span><span class="w"> </span><span class="n">pro_dbms_sql_all_02</span><span class="p">(</span><span class="n">HEXTORAW</span><span class="p">(</span><span class="s1">'DEADBEEF'</span><span class="p">),</span><span class="mi">0</span><span class="p">,</span><span class="mi">1</span><span class="p">);</span>
<span class="c1">-- Delete the stored procedure.</span>
<span class="k">DROP</span><span class="w"> </span><span class="k">PROCEDURE</span><span class="w"> </span><span class="n">pro_dbms_sql_all_02</span><span class="p">;</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_04_0550.html">Advanced Packages</a></div>
</div>
</div>