FTP/SFTP/SCP Connector

You are looking at an older version of the documentation. The latest version is found here.

Those connectors, known by the type names FTP, SFTP, and SCP, expose stored procedures to leverage file resources stored servers that are accessible using these protocols.

Connector-specific Connection Properties Shared by FTP, SFTP, SCP

Property name	Description	Default value
host	Host	`localhost`
`port`	Port	ftp, ftpes: `21` ftps: `990` sftp, scp: `22`
`user`	User	-
`password`	Password	-
`remoteDirectory`	Default remote directory	-

Connector-specific Connection Properties - FTP Only

Property name	Description	Default value
`secure`	Specifies if the remote server shall be accessed using TLS: FTPES (explicit TLS) if secure and explicit property are set to TRUE. FTPS (implicit TLS) if the secure property is set to true and explicit is set to FALSE.	FALSE
`explicit`	Enables FTPES (explicit TLS). This parameter works only with `secure` set to TRUE	FALSE
`passive`	Specifies if the remote server shall be accessed using passive mode	FALSE
`proxy`	Possible values: `NONE`, `HTTP`, `SOCKS4`, `SOCKS5`, `FTP`. Value `FTP` is only valid for FTP connector and thus should be set only as connection property, not a system property	-
`proxyHost`	Host address of the proxy server	-
`proxyPort`	Port used by the proxy server	-
`proxyUser`	User at proxy server server	-
`proxyPassword`	Password for the proxy server	-
`serverTimeout`	Server read timeout	`60`

Connector-Specific Connection Properties - SFTP Only

Property name	Description	Default value
privatekey	Specifies the s path to a keyfile. This parameter may be set instead of the password parameter	-
`proxy`	Possible values: `NONE`, `HTTP`, `SOCKS4`, `SOCKS5`	-
`proxyHost`	Host adress of the proxy server	-
`proxyPort`	Port used by the proxy server	-
`proxyUser`	User at the proxy server	-
`proxyPassword`	Password for the proxy server	-
`config`	Used for SSH configuration	`StrictHostKeyChecking=no`

config connection property available since v3.13

Usage and Examples

FTP

Usage

SQL

CALL SYSADMIN.createConnection(name => <ftp_alias>, jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>,secure=<true/false>,passive=<true/false>') ;;
CALL SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL

CALL SYSADMIN.createConnection(name => 'ftp', jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=myserver,poer=21,user=JohnDoe,password=mySecretPassword,secure=false,passive=true') ;;
CALL SYSADMIN.createDataSource(name => 'ftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

SFTP

Usage

SQL

CALL SYSADMIN.createConnection(name => <sftp_alias>, jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
CALL SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL

CALL SYSADMIN.createConnection(name => 'sftp', jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
CALL SYSADMIN.createDataSource(name => 'sftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

SCP

Usage

SQL

CALL SYSADMIN.createConnection(name => <scp_alias>, jbossCLITemplateName => 'scp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
CALL SYSADMIN.createDataSource(name => <scp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

Example

SQL

CALL SYSADMIN.createConnection(name => 'scp', jbossCLITemplateName => 'scp', cconnectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
CALL SYSADMIN.createDataSource(name => 'scp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;

We don't have a way to export this macro.