FTP Adapter

The FTP Adapter gives you access to remote FTP sites using SQL commands and REST requests.

This adapter works with FTP and FTPS sites.

Want to try it in Azure? Click here to learn more or click here to create a new Enzo Server RTM 3.1 Azure VM now.

Want to try it in AWS? Click here to learn more or click here to create a new Enzo Server RTM 3.1 AWS VM now.

Configuration Settings

Name	Description	Default
Boolean _isDefault	Make this the default configuration. Defaults to true if configName is already the default.
String uri	FTP target URL or URI, including "ftp://"
String uid	FTP login UserId
String pwd	FTP login password
Boolean isPassive	Enable passive mode	False
Boolean isBinary	Enable binary file transmission	False
Boolean isSSL	Use SSL encryption over transmission	False

Handlers

append

Appends data at the end of a file using the default connection file type (binary or ascii). details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content to append

SQL Call

EXEC ftp.append './files/test.txt', 'more data'

Http Call

/bsc/ftp/append

Output Columns

This call does not return data.

append_ascii

Appends data at the end of an ascii file. details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content to append

SQL Call

EXEC ftp.append_ascii './files/test.txt', 'more data'

Http Call

/bsc/ftp/append_ascii

Output Columns

This call does not return data.

append_binary

Appends data at the end of a binary file. details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content to append

SQL Call

EXEC ftp.append './files/test.data', 0x01020304

Http Call

/bsc/ftp/append_binary

Output Columns

This call does not return data.

delete
||table_name||

Deletes a file. details

Arguments

dir

Lists the content of a directory. details

Arguments

Name	Description	Default
name	The name of the directory (send null for the root directory)

SQL Call

EXEC ftp.dir
EXEC ftp.dir './files'

Http Call

/bsc/ftp/dir

Output Columns

String FileName

The name of the file or directory

directories

List directories under the path provided. details

Arguments

Name	Description	Default
name	The path under which to list available directories (leave null for the root directory)

SQL Call

EXEC ftp.directories './files'

Http Call

/bsc/ftp/directories

Output Columns

This call does not return data.

downloadFile

Downloads a single file from an FTP site to a local drive. details

Arguments

Name	Description	Default
fileName	The name of the file to download. Leave blank to use the default file name; you can also use a path from the root directory.
downloadPath	The full path of the file name to create locally. If not provided, a temporary file will be created.

SQL Call

EXEC ftp.downloadfile '/files/test.data'

Http Call

/bsc/ftp/downloadfile

Output Columns

String fileName
String tmpFileName
Int64 byteTx
Double elapsedTime

get

Gets the content of a file using the default connection file type (binary or ascii). details

Arguments

Name	Description	Default
fileName R	The name of the file

SQL Call

EXEC ftp.get './files/test.zip'

Http Call

/bsc/ftp/get

Output Columns

This call does not return data.

get_ascii

Gets the content of an ascii file. details

Arguments

Name	Description	Default
fileName R	The name of the file

SQL Call

EXEC ftp.get_ascii './files/test.txt'

Http Call

/bsc/ftp/get_ascii

Output Columns

String Content

The content of the file

get_binary

Gets the content of a binary file. details

Arguments

Name	Description	Default
fileName R	The name of the file

SQL Call

EXEC ftp.get_binary './files/test.zip'

Http Call

/bsc/ftp/get_binary

Output Columns

Object Content

The content of the file

Lists the files in a directory. details

Arguments

Name	Description	Default
name	The name of the directory (send null for the root directory)

SQL Call

EXEC ftp.ls
EXEC ftp.ls './files'

Http Call

/bsc/ftp/ls

Output Columns

String FileName

The name of the file

mkdir

Creates a new directory from the current working directory. details

Arguments

Name	Description	Default
name R	The name of the directory

SQL Call

EXEC ftp.mkdir 'test'
EXEC ftp.mkdir './files/test'

Http Call

/bsc/ftp/mkdir

Output Columns

This call does not return data.

put

Creates a file using the default connection file type (binary or ascii). details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content of the file

SQL Call

EXEC ftp.put './files/test.data', 0x01020304

Http Call

/bsc/ftp/put

Output Columns

This call does not return data.

put_ascii

Creates an ascii file. details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content of the file

SQL Call

EXEC ftp.put_ascii './files/test.txt', 'test data'

Http Call

/bsc/ftp/put_ascii

Output Columns

This call does not return data.

put_binary

Creates a binary file. details

Arguments

Name	Description	Default
fileName R	The name of the file
content R	The content of the file

SQL Call

EXEC ftp.put_binary './files/test.data', 0x01020304

Http Call

/bsc/ftp/put_binary

Output Columns

This call does not return data.

rename
||table_name||

Renames a file. details

Arguments

rmdir

Deletes a directory from the current working directory. details

Arguments

Name	Description	Default
name R	The name of the directory

SQL Call

EXEC ftp.rmdir 'test'
EXEC ftp.rmdir './files/test'

Http Call

/bsc/ftp/rmdir

Output Columns

This call does not return data.

size

Gets the size of a file. details

Arguments

Name	Description	Default
fileName R	The name of the file

SQL Call

EXEC ftp.size 'test.zip'
EXEC ftp.size './files/test.zip'

Http Call

/bsc/ftp/size

Output Columns

String fileName	The name of the file
String FileSize	The size of the file in bytes

upload

Uploads a single file to an FTP site details

Arguments

Name	Description	Default
fileName	The name of the file to upload.
targetFile R	The full path of the file name to create on the FTP site
overwrite	When true overwrite the file on the FTP server

SQL Call

EXEC ftp.upload 'c:\tmp\test.data', './files/test.data'

Http Call

/bsc/ftp/upload

Output Columns

This call does not return data.

BLOGS AND VIDEOS

IN THE NEWS

OTHER

FTP Adapter

Configuration Settings

Handlers

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

PLATFORM

SOLUTIONS

RESOURCES

COMPANY