Amazon S3 Export Integration V1

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

Amazon Simple Storage Service (Amazon S3) is an object storage service that offers scalability, data availability, security, and performance. You can use it to store and protect any amount of data for things such as data lakes, websites, mobile applications, backup and restore, archive, enterprise applications, IoT devices, and big data analytics. Amazon S3 provides features for data organization and configuration of access controls for your business, organization, and compliance requirements.

This TD export integration allows you to write job results from Treasure Data directly to Amazon S3.

What can you do with this Integration?

• Storing data: Store an infinite amount of data in a bucket.

Prerequisites

• Basic knowledge of Treasure Data, including the TD Toolbelt.
• For AWS: the IAM User with s3:PutObject and s3:AbortMultipartUpload permissions. We recommend that you set no other permissions for the IAM User used for this connection.

Requirements and Limitations

• The query result limit for export to S3 is 100GB. If the query result exceeds the limit, you see the following message in the log: The number of chunks for multipart upload is exceeded. Try to split data by query.
• The default export format is CSV RFC 4180.
• Output in TSV format is also supported.

Static IP Address of Treasure Data Integration

If your security policy requires IP whitelisting, you must add Treasure Data's IP addresses to your allowlist to ensure a successful connection.

Please find the complete list of static IP addresses, organized by region, at the following link:
https://api-docs.treasuredata.com/en/overview/ip-addresses-integrations-result-workers/

About S3 Server-Side Encryption

You can encrypt upload data with AWS S3 Server-Side Encryption. You don’t need to prepare an encryption key for this. Data will be encrypted on the server side using the 256-bit Advanced Encryption Standard (AES-256).

Use the Server-Side Encryption bucket policy if you require server-side encryption for all objects that are stored in your bucket. When you have server-side encryption enabled, you don't have to turn on the use_sse option. However, job results might fail if you have bucket policies set to reject HTTP requests without encryption information.

td query \
--result 's3://accesskey:secretkey@/bucketname/path/to/file.csv?use_sse=true&sse_algorithm=AES256' \
-w -d testdb \
"SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code"

About File Formats for S3

The default export format is CSV RFC 4180. Output in TSV format is also supported.

Options to customize file format...

For both CSV and TSV formats, you can use the following table lists options to customize the final format of the files written into the destination:

The following example shows a default sample output in CSV format when no customization is requested:

code,cnt
"200",4981
"302",
"404",17
"500",2

When the format=tsv, delimiter=“, and null=NULL options are specified:

td query \
--result 's3://accesskey:secretkey@/bucket_name/path/to/file.tsv?format=tsv&delimiter=%22&null=empty' \
-w -d testdb \
"SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code"

The access key and secret key must be URL encoded. The output changes to:

"code" "cnt"
"200" 4981
"302" NULL
"404" 17
"500" 2

Use the TD Console to Create a Connection

In Treasure Data, you must create and configure the data connection before running your query. As part of the data connection, you provide authentication to access the integration.

Create a New Authentication

1. Open TD Console.
2. Navigate to Integrations Hub > Catalog.
3. Search for AWS S3.
4. Select Create Authentication.
5. The New Authentication dialog opens. You need a client ID and access keys to authenticate using credentials. 
6. Set the following parameters.

7. Select Continue.
8. Name your new AWS S3 connection.
9. Select Done.

Define your Query

1. Complete the instructions in Creating a Destination Integration.
2. Navigate to Data Workbench > Queries.
3. Select a query for which you would like to export data.
4. Run the query to validate the result set.
5. SelectExport Results.
6. Select an existing integration authentication.
7. Define any additional Export Results details. In your export integration content review the integration parameters. For example, your Export Results screen might be different, or you might not have additional details to fill out.
8. Select Done.
9. Run your query.
10. Validate that your data moved to the destination you specified.

Specify the Result Export Target

1. Select Export Results.
2. You can select an existing authentication or create a new authentication for the external service to be used for output. Choose one of the following: Use Existing Integration Create a New Integration

(Optional) Specify information for Export to Amazon S3

Integration Parameters for S3

Define the following transfer parameters:

• If the Use AWS S3 Server-Side Encryption box is checked:

  • Server-Side Encryption algorithm.(Ex. AES256).

• Bucket: Provide the S3 bucket name (Ex. your_bucket_name).

• Path: Specify a prefix for target keys (Ex. logs/data_).

• Format: Format of the exported files (Ex. csv (comma separated or tab separated)).

• Compression: The compression format of the exported files (Ex. None or gz).

• Delimiter: Use to specify the delimiter character (Ex, (comma)).

• String for null cells: Placed holder to insert for null values (Ex. Empty String).

• End-of-line character: Specify the EOL(End-Of-Line) representation (Ex. CRLF).

• Quote Character (Optional): The character used for quotes in the exported file (Ex. "). Only quote the fields which contain the delimiter, quote, or any of the characters in the lineterminator.

• Escape character (Optional): The escape character used in the exported file.

Example Query

For example:

SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code

1. Verify the results in the Amazon S3 bucket that you specified while entering the transfer details.

Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to Audience Studio.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select Create Activation.
4. In the Details panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the Output Mapping panel.

• Attribute Columns
  • Select Export All Columns to export all columns without making any changes.
  • Select + Add Columns to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select + Add Columnsto add new columns for your activation output.
• String Builder
  • + Add string to create strings for export. Select from the following values:
    • String: Choose any value; use text to create a custom value.
    • Timestamp: The date and time of the export.
    • Segment Id: The segment ID number.
    • Segment Name: The segment name.
    • Audience Id: The parent segment number.

6. Set a Schedule.

• Select the values to define your schedule and optionally include email notifications.

7. Select Create.

• Achieving Time Partitioning in S3 of Data Exported using Bulk Export

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is ‘0 0 1 * 1’, then the ‘day of month’ specification and ‘day of week’ are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

(Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is '0 0 1 * 1', then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

Scheduling your Job Using TD Console

1. Navigate to Data Workbench > Queries

2. Create a new query or select an existing query.

3. Next to Schedule, select None.

4. In the drop-down, select one of the following schedule options:

   Drop-down Value	Description
   Custom cron...	Review Custom cron... details.
   @daily (midnight)	Run once a day at midnight (00:00 am) in the specified time zone.
   @hourly (:00)	Run every hour at 00 minutes.
   None	No schedule.

Custom cron... Details

 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)

The following named entries can be used:

• Day of Week: sun, mon, tue, wed, thu, fri, sat.
• Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

A single space is required between each field. The values for each field can be composed of:

1. (Optional) You can delay the start time of a query by enabling the Delay execution.

Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

(Optional) You can delay the start time of a query by enabling the Delay execution.

(Optional) Configure Export Results in Workflow

Within Treasure Workflow, you can specify the use of this data connector to export data.

• About Using Workflows to Export Data with TD Toolbelt for more information on using data connectors in the workflow to export data.
• Treasure Boxes to see an example workflow.
• About Workflow Secrets Management to learn more about how to configure secrets to mask credentials in your workflow.

Learn more at Using Workflows to Export Data with the TD Toolbelt.

timezone: UTC  _export:   td:     database: sample_datasets  +td-result-into-s3:   td>: queries/sample.sql   result_connection: your_connections_name   result_settings:     bucket: your_bucket     path: /path/file_${moment(session_time).format("YYYYMMDD")}.csv.gz     compression: 'gz'     header: true     newline: \r\n     "null": "hoge"

(Optional) Export Integration Using the CLI

If the TD Console is not available or does not meet your needs, you can use the CLI to issue queries and output results. Format the query output results using the CLI.

Required

The access key and secret key must be URL encoded.

Define the Query Export in CLI

To output the result of a single query to an S3 buck add the --result option to the td query command. After the job is finished, the results are written into your database.

For on-demand jobs, just add the --result option to the td query command. After the job is finished, the results are written to the S3 bucket with the given name and path. The access key and secret key must be URL encoded.

td query \
--result 's3://accesskey:secretkey@/bucketname/path/to/file.csv.gz?compression=gz' \
-w -d testdb \
"SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code"

For security reasons, you may want to use AWS IAM to manage storage write and access permissions.

You can specify the compression option (only gz is allowed at this moment) in —result URL to compress the result. Without the compression parameter, it generates uncompressed data. The access key and secret key must be URL encoded.

td query \ --result 's3://accesskey:secretkey@/bucketname/path/to/file.csv' \
-w -d testdb \ "SELECT code, COUNT(1) AS cnt FROM www_access GROUP BY code"