Learn more about SFTP Server Export Integration.
The Data Connector for SFTP enables you to import files stored on your SFTP server to Treasure Data.
For sample workflows of importing files from your STFP server, view Treasure Boxes.
Basic knowledge of Treasure Data
Before using this connector, determine valid protocols for your environment.
If you intend to SFTP, you can use this Data Connector for SFTP.
Open_SSH key format is supported.
Open SSH 7.8 Private Key is supported.
If you are using a firewall, check your accepted IP range/port. Server administrators sometimes change the default port number from TCP/22 for security reasons.
Requires that your private key has an OpenSSH 7.8 format.
Requires that the OpenSSH format private key was generated using the '-m PEM' option.
“PuTTY” and other formats are not supported.
The default format of the private key after OpenSSH.
After installation and configuration, review the job log. Warning and errors provide information about the success of your import. For example, you can identify the source file names associated with import errors.
You can use TD Console to create your data connector.
When you configure a data connection, you provide authentication to access the integration. In Treasure Data, you configure the authentication and then specify the source information.
Open TD Console.
Navigate to Integrations Hub > Catalog.
Locate and select SFTP.
The following dialog opens.
Type the required credentials for your remote SFTP instance:
Host: The host information of the remote SFTP instance, for example, an IP address.
Port: The connection port on the remote FTP instance, the default is 22.
User: The user name used to connect to the remote FTP instance.
Authentication mode: The way you choose to authenticate with your SFTP server.
Secret key file: Required if 'public / private key pair' is selected from `Authentication Mode`. (The key type ed25519 is not supported but the ecdsa key type is supported.)
Passphrase for secret key file: (Optional) If required, provide a passphrase for the provided secret file.
Retry limit: Number of times to retry a failed connection (default 10).
Timeout: Connection timeout in seconds (default 600).
Type a name for your connection.
If you would like to share this connection with other users in your organization, select Share with others.
If this box is unchecked this connection is visible only to you.
To get the data from your SFTP server into Treasure Data, you can set up an ad hoc one-time transfer or a recurring transfer at a regular interval. After creating the authenticated connection, you are automatically taken to Authentications.
Search for the connection you created.
Select New Source.
Type a name for your Source in the Data Transfer field.
The Source dialog opens.
Edit the following parameters
User directory root
The prefix of target files (string, required)
Path match pattern
Type a regular expression to query file paths. If a file path doesn’t match with the specified pattern, the file is skipped. For example, if you specify the pattern .csv$ #, then a file is skipped if its path doesn’t match the pattern.
Enables incremental loading (boolean, optional. default: true. If incremental loading is enabled, the config diff for the next execution will include last_path parameter so that the next execution skips files before the path. Otherwise, last_path is not included.
Start after path
Only paths lexicographically greater than this will be imported.
The Data Settings page opens.
Optionally, edit the data settings or skip this page of the dialog.