<!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: ftp_get - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: ftp_get - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<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: ftp_get - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<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_ftp_get" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - ftp_get</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_dbname.html" title="dbname">Prev</a> | <a class="link" href="fn_ftp_ls.html" title="ftp_ls">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 & 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 & 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 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 & 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 class="selected" href="functions.html#ws">Web & Internet</a>
</div>
<div class="selected">
<div>
<a href="fn_dav_api_add.html">dav add & update fun...</a>
</div>
<div>
<a href="fn_dav_api_lock.html">dav lock manipulatio...</a>
</div>
<div>
<a href="fn_dav_api_change.html">dav manipulation fun...</a>
</div>
<div>
<a href="fn_dav_api_search.html">dav search functions</a>
</div>
<div>
<a href="fn_dav_exp.html">dav_exp</a>
</div>
<div>
<a href="fn_lfs_exp.html">lfs_exp</a>
</div>
<div>
<a href="fn_serv_queue_top.html">serv_queue_top</a>
</div>
<div>
<a href="fn_urlrewrite_create_regex_rule.html">urlrewrite_create_re...</a>
</div>
<div>
<a href="fn_USER_KEY_LOAD.html">user_key_load</a>
</div>
<div>
<a href="fn_vhost_define.html">vhost_define</a>
</div>
<div>
<a href="fn_vhost_remove.html">vhost_remove</a>
</div>
<div>
<a href="fn_dav_api_user.html">webdav users & group...</a>
</div>
<div>
<a href="fn_client_attr.html">client_attr</a>
</div>
<div>
<a href="fn_connection_get.html">connection_get</a>
</div>
<div>
<a href="fn_connection_id.html">connection_id</a>
</div>
<div>
<a href="fn_connection_is_dirty.html">connection_is_dirty</a>
</div>
<div>
<a href="fn_connection_set.html">connection_set</a>
</div>
<div>
<a href="fn_connection_vars.html">connection_vars</a>
</div>
<div>
<a href="fn_connection_vars_set.html">connection_vars_set</a>
</div>
<div>
<a href="fn_dbname.html">dbname</a>
</div>
<div>
<a class="selected" href="fn_ftp_get.html">ftp_get</a>
</div>
<div>
<a href="fn_ftp_ls.html">ftp_ls</a>
</div>
<div>
<a href="fn_ftp_put.html">ftp_put</a>
</div>
<div>
<a href="fn_get_certificate_info.html">get_certificate_info</a>
</div>
<div>
<a href="fn_get_keyword.html">get_keyword</a>
</div>
<div>
<a href="fn_get_keyword_ucase.html">get_keyword_ucase</a>
</div>
<div>
<a href="fn_http.html">http</a>
</div>
<div>
<a href="fn_http_acl_get.html">http_acl_get</a>
</div>
<div>
<a href="fn_http_acl_remove.html">http_acl_remove</a>
</div>
<div>
<a href="fn_http_acl_set.html">http_acl_set</a>
</div>
<div>
<a href="fn_http_body_read.html">http_body_read</a>
</div>
<div>
<a href="fn_http_client.html">http_client</a>
</div>
<div>
<a href="fn_http_client_ext.html">http_client_ext</a>
</div>
<div>
<a href="fn_http_client_ip.html">http_client_ip</a>
</div>
<div>
<a href="fn_http_debug_log.html">http_debug_log</a>
</div>
<div>
<a href="fn_http_enable_gz.html">http_enable_gz</a>
</div>
<div>
<a href="fn_http_file.html">http_file</a>
</div>
<div>
<a href="fn_http_flush.html">http_flush</a>
</div>
<div>
<a href="fn_http_get.html">http_get</a>
</div>
<div>
<a href="fn_http_header.html">http_header</a>
</div>
<div>
<a href="fn_http_header_get.html">http_header_get</a>
</div>
<div>
<a href="fn_http_kill.html">http_kill</a>
</div>
<div>
<a href="fn_http_listen_host.html">http_listen_host</a>
</div>
<div>
<a href="fn_http_lock.html">http_lock</a>
</div>
<div>
<a href="fn_http_map_get.html">http_map_get</a>
</div>
<div>
<a href="fn_http_map_table.html">http_map_table</a>
</div>
<div>
<a href="fn_http_param.html">http_param</a>
</div>
<div>
<a href="fn_http_path.html">http_path</a>
</div>
<div>
<a href="fn_http_pending_req.html">http_pending_req</a>
</div>
<div>
<a href="fn_http_physical_path.html">http_physical_path</a>
</div>
<div>
<a href="fn_http_proxy.html">http_proxy</a>
</div>
<div>
<a href="fn_http_request_get.html">http_request_get</a>
</div>
<div>
<a href="fn_http_request_header.html">http_request_header</a>
</div>
<div>
<a href="fn_http_request_status.html">http_request_status</a>
</div>
<div>
<a href="fn_http_rewrite.html">http_rewrite</a>
</div>
<div>
<a href="fn_http_root.html">http_root</a>
</div>
<div>
<a href="fn_http_unlock.html">http_unlock</a>
</div>
<div>
<a href="fn_http_url.html">http_url</a>
</div>
<div>
<a href="fn_http_value.html">http_value</a>
</div>
<div>
<a href="fn_http_xslt.html">http_xslt</a>
</div>
<div>
<a href="fn_json_parse.html">json_parse</a>
</div>
<div>
<a href="fn_ses_connect.html">ses_connect</a>
</div>
<div>
<a href="fn_ses_disconnect.html">ses_disconnect</a>
</div>
<div>
<a href="fn_ses_read_line.html">ses_read_line</a>
</div>
<div>
<a href="fn_ses_write.html">ses_write</a>
</div>
<div>
<a href="fn_tcpip_gethostbyaddr.html">tcpip_gethostbyaddr</a>
</div>
<div>
<a href="fn_tcpip_gethostbyname.html">tcpip_gethostbyname</a>
</div>
<div>
<a href="fn_vsp_calculate_digest.html">vsp_calculate_digest</a>
</div>
<div>
<a href="fn_wsdl_import_udt.html">wsdl_import_udt</a>
</div>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>ftp_get</h2>
<div class="refpurpose">FTP get command; Virtuoso FTP client</div>
<div class="funcsynopsis">
<span class="funcdef">integer <span class="function">ftp_get</span>
</span>
(<span class="paramdef">in <span class="parameter">server</span> varchar</span>,
<span class="paramdef">in <span class="parameter">user</span> varchar</span>,
<span class="paramdef">in <span class="parameter">pass</span> varchar</span>,
<span class="paramdef">in <span class="parameter">remote_file_name</span> varchar</span>,
<span class="paramdef">in <span class="parameter">local_file_name</span> varchar</span>,
<span class="paramdefoptional">[in <span class="optional">is_pasv</span> integer]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>Virtuoso has FTP client functionality, that can be used inside Virtuoso/PL. This Virtuoso function mimics the FTP get command. As with any PL, this can be combined with Web Services and SOAP.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">server – </span>
The remote server address or IP Address.</div>
<div class="refsect2">
<span class="refsect2title">user – </span>
The username for authentication at the FTP server.</div>
<div class="refsect2">
<span class="refsect2title">pass – </span>
The accompanying password for authentication at the FTP server.</div>
<div class="refsect2">
<span class="refsect2title">remote_file_name – </span>
Full path and file name to the file on the FTP server to be downloaded.</div>
<div class="refsect2">
<span class="refsect2title">local_file_name – </span>
The full path and file name of the local save point. This is relative to the server root directory. This directory must be included in DirsAllowed ACL list in the Virtuoso.INI file.</div>
<div class="refsect2">
<span class="refsect2title">is_pasv – </span>
Flag to specify whether to use passive mode. This can be one "1"
for passive mode, or zero "0" for active mode. One "1" is assumed by default.</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>This function returns the size of the file written to the local file system.</p>
</div>
<div class="refsect1title">Errors</div>
<p>This function will return any errors returned by the remote FTP server.</p>
<p />
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_ftp_get" />
<div class="example">
<div class="exampletitle">Retrieving a file from an FTP server</div>
<p>To get the file virtuoso30.tar.gz from the ftp server ftp.openlinksw.com, one can use:</p>
<div>
<pre class="screen">
select ftp_get ('ftp.openlinksw.com', 'user_name', 'password', 'virtuoso30.tar.gz', 'virtuoso30.tar.gz');
</pre>
</div>
<p>This will download the file which occurs on the root directory of the server, and save
it to the local server root directory.</p>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_ftp_put.html">ftp_put()</a>
</p>
<p>
<a href="fn_ftp_ls.html">ftp_ls()</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
289
