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 TD Toolbelt.
Create Seed Config File (seed.yml)
First, prepare seed.yml as shown in the following example, with your FTP details. You must also specify bucket name, and target file name (or prefix for multiple files).
The Data Connector for FTP imports all files that match the specified prefix (e.g. path_prefix: path/to/sample_ > path/to/sample_201501.csv.gz, path/to/sample_201502.csv.gz, …, path/to/sample_201505.csv.gz).
Active Mode is NOT supported.
If you’re using FTPS, specify additional details as follows:
For more details, see modes for out plugin.
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 assessed file format definitions including file formats, encodings, column names, and types.
Then, you can preview how the system will parse the file by using the preview command.
The guess command needs more than 3 rows and 2 columns in source data file, because the command assesses the 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
Finally, 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:
At present, 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 FTP file import. We take great care in distributing and operating our scheduler to achieve high availability. By using this feature, you no longer need a cron daemon on your local data center.
For the scheduled import, the Data Connector for FTP 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, the connector 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 (see data partitioning).
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. Note that `--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 removes the schedule.
Modes for Out Plugin
You can specify file import mode in the out section of the load.yml file. The out: section controls how data is imported into a Treasure Data table. Mode Description Examples Append Records are appended to the target table. Always Replace Replaces data in the target table. Any manual schema changes made to the target table remain intact. Replace on new data Replaces data in the target table only when there is new data to import.
For example, you may choose to append data or replace data in an existing table in Treasure Data.
The out: section controls how data is imported into a Treasure Data table.
Records are appended to the target table.
Replaces data in the target table. Any manual schema changes made to the target table remain intact.
Replace on new data
Replaces data in the target table only when there is new data to import.