Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 71d40963b505df4524269198e237b3e3 > files > 517

virtuoso-opensource-doc-6.1.4-2.fc14.noarch.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
 <head profile="http://internetalchemy.org/2003/02/profile">
  <link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
  <link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
  <meta name="dc.title" content="Function: rstmtexec - Virtuoso Functions Guide" />
  <meta name="dc.subject" content="Function: rstmtexec - Virtuoso Functions Guide" />
  <meta name="dc.creator" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
  <link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
  <link rel="parent" href="functions.html" title="Chapter Contents" />
  <link rel="prev" href="appendixa.html" title="Appendix" />
  <link rel="next" href="functions.html#.html" title="" />
  <link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
  <link rel="stylesheet" type="text/css" href="doc.css" />
  <link rel="stylesheet" type="text/css" href="/doc/translation.css" />
  <title>Function: rstmtexec - Virtuoso Functions Guide</title>
  <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
  <meta name="author" content="OpenLink Software Documentation Team ;&#10;" />
  <meta name="copyright" content="OpenLink Software, 1999 - 2009" />
  <meta name="keywords" content="" />
  <meta name="GENERATOR" content="OpenLink XSLT Team" />
 </head>
 <body>
  <div id="header">
    <a name="fn_rstmtexec" />
    <img src="../images/misc/logo.jpg" alt="" />
    <h1>22. Virtuoso Functions Guide - rstmtexec</h1>
  </div>
  <div id="navbartop">
   <div>
      <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_rexecute.html" title="rexecute">Prev</a> | <a class="link" href="fn_rmoreresults.html" title="rmoreresults">Next</a>
   </div>
  </div>
  <div id="currenttoc">
   <form method="post" action="/doc/adv_search.vspx">
    <div class="search">Keyword Search: <br />
        <input type="text" name="q" /> <input type="submit" name="go" value="Go" />
    </div>
   </form>
   <div>
      <a href="http://www.openlinksw.com/">www.openlinksw.com</a>
   </div>
   <div>
      <a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
   </div>
    <br />
   <div>
      <a href="index.html">Book Home</a>
   </div>
    <br />
   <div>
      <a href="contents.html">Contents</a>
   </div>
   <div>
      <a href="preface.html">Preface</a>
   </div>
    <br />
   <div>
      <a class="selected" href="functions.html">Virtuoso Functions Guide</a>
   </div>
    <br />
   <div>
      <a href="functions.html#admin">Administration</a>
   </div>
   <div>
      <a href="functions.html#aggr">Aggregate Functions</a>
   </div>
   <div>
      <a href="functions.html#array">Array Manipulation</a>
   </div>
   <div>
      <a href="functions.html#bpel">BPEL APIs</a>
   </div>
   <div>
      <a href="functions.html#backup">Backup</a>
   </div>
   <div>
      <a href="functions.html#compression">Compression</a>
   </div>
   <div>
      <a href="functions.html#cursors">Cursor</a>
   </div>
   <div>
      <a href="functions.html#time">Date &amp; Time Manipulation</a>
   </div>
   <div>
      <a href="functions.html#debug">Debug</a>
   </div>
   <div>
      <a href="functions.html#dict">Dictionary Manipulation</a>
   </div>
   <div>
      <a href="functions.html#encoding">Encoding &amp; Decoding</a>
   </div>
   <div>
      <a href="functions.html#file">File Manipulation</a>
   </div>
   <div>
      <a href="functions.html#ft">Free Text</a>
   </div>
   <div>
      <a href="functions.html#hash">Hashing / Cryptographic</a>
   </div>
   <div>
      <a href="functions.html#ldap">LDAP</a>
   </div>
   <div>
      <a href="functions.html#localization">Locale</a>
   </div>
   <div>
      <a href="functions.html#mail">Mail</a>
   </div>
   <div>
      <a href="functions.html#misc">Miscellaneous</a>
   </div>
   <div>
      <a href="functions.html#number">Number</a>
   </div>
   <div>
      <a href="functions.html#phrz">Phrases</a>
   </div>
   <div>
      <a href="functions.html#rdf">RDF data</a>
   </div>
   <div>
      <a class="selected" href="functions.html#rmt">Remote SQL Data Source</a>
   </div>
   <div class="selected">
    <div>
        <a href="fn_att_local_name.html">att_local_name</a>
    </div>
    <div>
        <a href="fn_quote_dotted.html">quote_dotted</a>
    </div>
    <div>
        <a href="fn_rclose.html">rclose</a>
    </div>
    <div>
        <a href="fn_rexecute.html">rexecute</a>
    </div>
    <div>
        <a href="fn_rmoreresults.html">rmoreresults</a>
    </div>
    <div>
        <a href="fn_rnext.html">rnext</a>
    </div>
    <div>
        <a class="selected" href="fn_rstmtexec.html">rstmtexec</a>
    </div>
    <div>
        <a href="fn_sql_columns.html">sql_columns</a>
    </div>
    <div>
        <a href="fn_sql_config_data_sources.html">sql_config_data_sour...</a>
    </div>
    <div>
        <a href="fn_sql_data_sources.html">sql_data_sources</a>
    </div>
    <div>
        <a href="fn_sql_driver_connect.html">sql_driver_connect</a>
    </div>
    <div>
        <a href="fn_sql_get_installed_drivers.html">sql_get_installed_dr...</a>
    </div>
    <div>
        <a href="fn_sql_get_private_profile_string.html">sql_get_private_prof...</a>
    </div>
    <div>
        <a href="fn_sql_gettypeinfo.html">sql_gettypeinfo</a>
    </div>
    <div>
        <a href="fn_sql_primary_keys.html">sql_primary_keys</a>
    </div>
    <div>
        <a href="fn_sql_procedures.html">sql_procedures</a>
    </div>
    <div>
        <a href="fn_sql_remove_dsn_from_ini.html">sql_remove_dsn_from_...</a>
    </div>
    <div>
        <a href="fn_sql_special_columns.html">sql_special_columns</a>
    </div>
    <div>
        <a href="fn_sql_statistics.html">sql_statistics</a>
    </div>
    <div>
        <a href="fn_sql_tables.html">sql_tables</a>
    </div>
    <div>
        <a href="fn_sql_transact.html">sql_transact</a>
    </div>
    <div>
        <a href="fn_sql_write_file_dsn.html">sql_write_file_dsn</a>
    </div>
    <div>
        <a href="fn_sql_write_private_profile_string.html">sql_write_private_pr...</a>
    </div>
    <div>
        <a href="fn_vd_remote_data_source.html">vd_remote_data_sourc...</a>
    </div>
    <div>
        <a href="fn_vd_remote_proc_wrapper.html">vd_remote_proc_wrapp...</a>
    </div>
    <div>
        <a href="fn_vd_remote_table.html">vd_remote_table</a>
    </div>
    <div>
        <a href="fn_vd_statistics.html">vd_statistics</a>
    </div>
    <div>
        <a href="fn_vdd_disconnect_data_source.html">vdd_disconnect_data_...</a>
    </div>
    <div>
        <a href="fn_vdd_measure_rpc_time.html">vdd_measure_rpc_time</a>
    </div>
   </div>
   <div>
      <a href="functions.html#repl">Replication</a>
   </div>
   <div>
      <a href="functions.html#soap">SOAP</a>
   </div>
   <div>
      <a href="functions.html#sql">SQL</a>
   </div>
   <div>
      <a href="functions.html#string">String</a>
   </div>
   <div>
      <a href="functions.html#txn">Transaction</a>
   </div>
   <div>
      <a href="functions.html#type">Type Mapping</a>
   </div>
   <div>
      <a href="functions.html#uddi">UDDI</a>
   </div>
   <div>
      <a href="functions.html#udt">User Defined Types &amp; The CLR</a>
   </div>
   <div>
      <a href="functions.html#vad">VAD</a>
   </div>
   <div>
      <a href="functions.html#jvmpl">Virtuoso Java PL API</a>
   </div>
   <div>
      <a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
   </div>
   <div>
      <a href="functions.html#ws">Web &amp; Internet</a>
   </div>
   <div>
      <a href="functions.html#xml">XML</a>
   </div>
   <div>
      <a href="functions.html#XPATH">XPATH &amp; XQUERY</a>
   </div>
    <br />
   <div>
      <a href="functionidx.html">Functions Index</a>
   </div>
    <br />
  </div>
  <div id="text">
    <h2>rstmtexec</h2>
    <div class="refpurpose">execute a SQL statement on a remote DSN, provides a result set where applicable.</div>
    <div class="funcsynopsis">
        <span class="funcdef">
     <span class="function">rstmtexec</span>
     </span>
        (<span class="paramdef">in <span class="parameter">dsn</span> varchar</span>, 
        <span class="paramdef">in <span class="parameter">stmt</span> varchar</span>, 
        <span class="paramdefoptional">[in <span class="optional">max_rows</span> integer]</span>, 
        <span class="paramdefoptional">[in <span class="optional">params_array</span> vector]</span>);
      </div>
  
  
  
  <div class="refsect1">
      <div class="refsect1title">Description</div>
    <p>This function can be used to execute SQL on a remote data source
    directly.  It returns a result set where one is expected.  </p>
	<p>This function is wrapper for the <span class="computeroutput">rexecute()</span> 
	provided for convenience as a shortcut.</p>
	<p>Unless explicitly granted, only the DBA group is permitted to use the 
	<span class="computeroutput">rstmtexec()</span> to maintain security.  Caution is required 
	here since any user granted use of <span class="computeroutput">rstmtexec()</span> has 
	full control of the remote data source set-up by the DBA, albeit limited 
	to the overall abilities of the remote user on the remote data source.  
	Users can be granted and denied access to this function using the following 
	commands:</p>

<div>
        <pre class="programlisting">
GRANT REXECUTE ON &#39;&lt;attached_dsn_name&gt;&#39; TO &lt;user_name&gt;
REVOKE REXECUTE ON &#39;&lt;attached_dsn_name&gt;&#39; FROM &lt;user_name&gt;
</pre>
      </div>

  <p>This command directly affects the grant to the <span class="computeroutput">rexecute()</span>
  function, which is the underlying mechanism for providing this function.</p>

  </div>
  <div class="refsect1">
      <div class="refsect1title">Parameters</div>
    <div class="refsect2">
        <span class="refsect2title">dsn – </span>
      The data source where the SQL statement should be executed.
      You must make sure that you have already defined the data source
      using the <span class="computeroutput">
          <a href="fn_vd_remote_data_source.html">
      vd_remote_data_source</a>
        </span> function or by attaching tables from it.
    </div>
    <div class="refsect2">
        <span class="refsect2title">stmt – </span>
      the SQL statement to execute on the remote data source <span class="computeroutput">dsn</span>.
    </div>
    <div class="refsect2">
        <span class="refsect2title">max_rows – </span>
      This controls the number of rows to be returned as follows:
	  <ul>
          <li>negative - return no rows</li>
          <li>zero (0) - all rows (default)</li>
          <li>positive - specified number of rows</li>
        </ul>
    </div>
    <div class="refsect2">
        <span class="refsect2title">in_params – </span>
      A <span class="computeroutput">vector</span> of parameters to the statement if the
      executed statement has parameters.  IN input parameters are specified
      as literals whereas OUT and INOUT parameters are specified as vectors
      of 3 elements for OUT and 4 elements for INOUT as follows:
      <ul>
          <li>[0] - the type of the parameter (&#39;OUT&#39; or &#39;INOUT&#39;)</li>
          <li>[1] - the datatype that the parameter is bound to on the remote</li>
          <li>[2] - the buffer length for the output parameter</li>
          <li>[3] - (INOUT only) the input value of the parameter</li>
        </ul>
      Non-vector parameters in the in_params parameter of rstmtexec are
      considered IN parameters, so the rstmtexec remains backwards compatible.
    </div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Return Values</div>
    <p>This function returns a result set.</p>
  </div>
  
  <div class="refsect1">
      <div class="refsect1title">See Also</div>
    <p>
        <a href="fn_rexecute.html">rexecute()</a>,
	<a href="fn_rnext.html">rnext()</a>,
    <a href="fn_rmoreresults.html">rmoreresults()</a>,
    <a href="fn_rclose.html">rclose()</a>
      </p>
  </div>
</div>
  <div id="footer">
    <div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
   <div id="validation">
    <a href="http://validator.w3.org/check/referer">
        <img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
    </a>
    <a href="http://jigsaw.w3.org/css-validator/">
        <img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
    </a>
   </div>
  </div>
 </body>
</html>