This topic includes:
You can also use the FTP data connector from the command line interface. The following instructions show you how to import data using the CLI.
Install ‘td’ command v0.11.9 or later
Install the most current Treasure Data Toolbelt.
Create Seed Config File (seed.yml)
Prepare seed.yml as shown in the following example, with your SFTP details. We support two authentication methods: Public / Private Key Pair, and Password.
Public and Private Key Pair Authentication
Create seed.yml with the following content.
`secret_key_file` requires OpenSSH format.
Create seed.yml with the following content.
You can use the following special characters in the password: "#$!*@"
If you are using the proxy, add the additional information as shown:
The Data Connector for SFTP imports all files that match the specified prefix (e.g. path_prefix:
Guess Fields (Generate load.yml)
Use connector:guess. This command automatically reads the source file, and assesses (uses logic to guess) the file format.
If you open load.yml, you’ll see the guessed file format definitions including file formats, encodings, column names, and types. This example is trying to load CSV files.
Then, you can preview how the system will parse the file by using the preview command.
The guess command needs over 3 rows and 2 columns in source data file, because it guesses column definition using sample rows from source data.
If the system detects your column name or column type unexpectedly, modify load.yml directly and preview again.
Currently, the Data Connector supports parsing of “boolean”, “long”, “double”, “string”, and “timestamp” types.
You also must create a local database and table prior to executing the data load job. Follow these steps:
Execute Load Job
Submit the load job. It may take a couple of hours depending on the size of the data. Specify the Treasure Data database and table where the data should be stored.
It’s also recommended to specify --time-column option, because Treasure Data’s storage is partitioned by time (see data partitioning) If the option is not provided, the data connector chooses the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.
If your data doesn’t have a time column you can add a time column by using add_time filter option. For more details see add_time filter plugin.
The connector:issue command assumes that you have already created a database(td_sample_db)and a table(td_sample_table). If the database or the table do not exist in TD, the connector:issue command fails, so create the database and table manually or use --auto-create-table option with td connector:issue command to auto create the database and table:
The Data Connector does not sort records on server-side. To use time-based partitioning effectively, sort records in files beforehand.
If you have a field called `time`, you don't have to specify the `--time-column` option.
You can schedule periodic Data Connector execution for incremental SFTP file import. We configure our scheduler carefully to ensure high availability. By using this feature, you no longer need a crondaemon on your local data center.
For the scheduled import, the Data Connector for SFTP imports all files that match with the specified prefix (e.g. path_prefix:
path/to/sample_201505.csv.gz) at first and remembers the last path (
path/to/sample_201505.csv.gz) for the next execution.
On the second and on subsequent runs, it imports only files that comes after the last path in alphabetical (lexicographic) order. (
Create the Schedule
A new schedule can be created using the td connector:create command. The following are required: the name of the schedule, the cron-style schedule, the database and table where the data will be stored, and the Data Connector configuration file.
It’s also recommended to specify the --time-column option, because Treasure Data’s storage is partitioned by time.
The `cron` parameter also accepts three special options: `@hourly`, `@daily` and `@monthly`.
By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or --timezone option. The `--timezone` option supports only extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles' etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.
List the Schedules
You can see the list of currently scheduled entries by running the command td connector:list.
Show the Setting and Schedule History
td connector:show shows the execution setting of a schedule entry.
td connector:history shows the execution history of a schedule entry. To investigate the results of each individual run, use td job <jobid>.
Delete the Schedule
td connector:delete will remove the schedule.
Modes for out plugin
You can specify file import mode in out section of seed.yml.
This is the default mode and records are appended to the target table.
replace (In td 0.11.10 and later)
This mode replaces data in the target table. Note that any manual schema changes made to the target table will remain intact with this mode.