Sophie

Sophie

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

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: file_to_string_output - Virtuoso Functions Guide" />
  <meta name="dc.subject" content="Function: file_to_string_output - 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: file_to_string_output - 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_file_to_string_output" />
    <img src="../images/misc/logo.jpg" alt="" />
    <h1>22. Virtuoso Functions Guide - file_to_string_output</h1>
  </div>
  <div id="navbartop">
   <div>
      <a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_file_to_string.html" title="file_to_string">Prev</a> | <a class="link" href="fn_file_unlink.html" title="file_unlink">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 class="selected" href="functions.html#file">File Manipulation</a>
   </div>
   <div class="selected">
    <div>
        <a href="fn_csv_cols_def.html">csv_cols_def</a>
    </div>
    <div>
        <a href="fn_csv_load.html">csv_load</a>
    </div>
    <div>
        <a href="fn_csv_load_file.html">csv_load_file</a>
    </div>
    <div>
        <a href="fn_csv_parse.html">csv_parse</a>
    </div>
    <div>
        <a href="fn_csv_table_def.html">csv_table_def</a>
    </div>
    <div>
        <a href="fn_file_delete.html">file_delete</a>
    </div>
    <div>
        <a href="fn_file_dirlist.html">file_dirlist</a>
    </div>
    <div>
        <a href="fn_file_mkdir.html">file_mkdir</a>
    </div>
    <div>
        <a href="fn_file_mkpath.html">file_mkpath</a>
    </div>
    <div>
        <a href="fn_file_open.html">file_open</a>
    </div>
    <div>
        <a href="fn_file_stat.html">file_stat</a>
    </div>
    <div>
        <a href="fn_file_to_string.html">file_to_string</a>
    </div>
    <div>
        <a class="selected" href="fn_file_to_string_output.html">file_to_string_outpu...</a>
    </div>
    <div>
        <a href="fn_file_unlink.html">file_unlink</a>
    </div>
    <div>
        <a href="fn_get_csv_row.html">get_csv_row</a>
    </div>
    <div>
        <a href="fn_gz_file_open.html">gz_file_open</a>
    </div>
    <div>
        <a href="fn_os_chmod.html">os_chmod</a>
    </div>
    <div>
        <a href="fn_os_chown.html">os_chown</a>
    </div>
   </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 href="functions.html#rmt">Remote SQL Data Source</a>
   </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>file_to_string_output</h2>
    <div class="refpurpose">get contents of a file as a string output stream</div>
    <div class="funcsynopsis">
        <span class="funcdef">
     <span class="function">file_to_string_output</span>
     </span>
        (<span class="paramdef">in <span class="parameter">file</span> varchar</span>, 
        <span class="paramdef">in <span class="parameter">from</span> integer</span>, 
        <span class="paramdef">in <span class="parameter">to</span> integer</span>);
      </div>
  
  
  
  <div class="refsect1">
      <div class="refsect1title">Description</div>
    <p>This function requires dba privileges.</p>
    <p>This function returns a   string output stream
    initialized to contain the text of the file or its segment, on local file system path
    relative to the server&#39;s working directory.</p>
    <p>
        <span class="computeroutput">file_to_string_output</span> can handle longer
    files than
    <a href="fn_file_to_string.html">file_to_string</a>
    and the resulting string output, if too long to be converted into
    a varchar, can be stored inside a blob.</p>
    <p>Access controls in the server configuration file apply. An attempt
    to access a file in a directory where access is not explicitly allowed will signal an error.</p>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Parameters</div>
    <div class="refsect2">
        <span class="refsect2title">file – </span>
      a <span class="computeroutput">varchar</span> path relative to server&#39;s working directory.
    </div>
    <div class="refsect2">
        <span class="refsect2title">from – </span>
      an optional <span class="computeroutput">integer</span> byte offset of the start of the segment to
      extract. Defaults to 0.
    </div>
    <div class="refsect2">
        <span class="refsect2title">to – </span>
      an optional <span class="computeroutput">integer</span> byte offset of the end of the requested segment.
      Defaults to file length.
    </div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">Examples</div>
    <a name="ex_file_to_string_output" />
      <div class="example">
        <div class="exampletitle">Insert file contents into a table</div>
      <p>This example shows how to insert file contents into
      a table <span class="computeroutput">file_table</span> with
      two columns.</p>
      <div>
          <pre class="screen">
create table
file_table (
  ft_name varchar,
  ft_cont long varbinary,
  primary key (ft_name));

create procedure
insert_files (in fname varchar)
{
  declare strout_handle any;

  strout_handle := file_to_string_output (fname);
  insert into file_table (ft_name, ft_cont)
    values (fname, strout_handle);

  strout_handle := file_to_string_output (fname, 10);
  insert into file_table (concat (ft_name, &#39;_1&#39;), ft_cont)
    values (fname, strout_handle);

  strout_handle := file_to_string_output (fname, 10, 20);
  insert into file_table (concat (ft_name, &#39;_2&#39;), ft_cont)
    values (fname, strout_handle);
};

insert_file (&#39;foo.dat&#39;);
      </pre>
        </div>
    </div>
  </div>
  <div class="refsect1">
      <div class="refsect1title">See Also</div>
    <p>
        <a href="fn_file_to_string.html">file_to_string
    </a>,
    <a href="fn_string_to_file.html">string_to_file
    </a>,
    <a href="fn_string_output.html">string_output</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>