Export to FTP

Exports a single database table to an FTP or SFTP server. Supports password authentication.

Information at a Glance

Parameter

 Description
Category Tools
Data source type DB
Send output to other operators No
Data processing tool Database

Input

A database table from a preceding operator.

Bad or Missing Values
Null values in the input table are converted to the string null. Empty values are kept as blank values in the FTP file exported.

Restrictions

The default maximum number of values allowed for the input table is 150 million (for example, 3M rows * 50 columns). If the input is larger, the operator fails with a meaningful error message. This limit is set to prevent causing memory issues on the TIBCO Data Science - Team Studio server; however, this value is configurable in the configuration file alpine.conf. Set the following parameter in the configuration file.

custom_operator.ftp_export.db_table_max_cells = 150000000

Configuration

Parameter Description
Notes Notes or helpful information about this operator's parameter settings. When you enter content in the Notes field, a yellow asterisk appears on the operator.
Server Protocol Specify the FTP server protocol, either FTP (the default) or SFTP.
Server Hostname Enter the FTP server hostname (without the protocol).
Server Port Enter the FTP server port.
Username Enter the username to authenticate on the FTP server.
Password Enter the password for the specified username to authenticate on the FTP server.
Account (FTP Only) Optional - For FTP only.

Specify the account password if one is required to authenticate on the FTP server.

Delimiter Specify one of the following delimiters for the output file.
  • Comma (the default)
  • Tab
  • Pipe
  • Tilde
Text Qualifier Specify whether the operator should handle escaping special characters and enclosing values in double quotes, if required.

Can be either None (the default) or Double Quotes.

If this option is set to Double Quotes, the following rules apply.

  • If the input value contains a comma, newline, or double quote, the output value is enclosed in double quotes.
  • Any double-quotes character in the input value is escaped with another double quote.
  • If the value does not contain a comma, newline, or double quote, it is returned unchanged.

Output Directory The location to store the output files.
Output Name The name to contain the results.
Overwrite File if Exists If set to true (the default), the existing file on the FTP server is overwritten.
Note: If the output path corresponds to an existing directory, it is not overwritten. An error is displayed with the message to delete this directory or to choose a different combination of Output Directory and Output Name.
Fetch Size Define the number of entries to read from database at once.

Default value: 20000.

Output

Visual Output
Visual Output - Summary

Data Output
None. This is a terminal operator.

Additional Notes

Permissions on Output File

Permissions on the output file are set to 640, and if the directory was created during the export process (that is, it did not exist already), directory permissions are set to 750.

Note: Some FTP servers do not support the chmod command. In this case, permissions are not changed on the output file and output directory. A warning in the user interface indicates that the permissions could not be changed.