On this Page

Snap type:

Write

Description:

The TPT Load Snap uses the 'tbuild' command installed in the Operating System to load data into empty tables. Teradata tbuild program should be installed on the Snaplex where the Snap is being executed. The Snap generates a script based on the field mapping which is executed using the tbuild program The Snap also captures the output generated from the tbuild program and writes to the OUT field in the output document.

Expected downstream Snaps: Any Snap with a document input view
Expected input: A stream of documents to be loaded into the table. Each input document contains values for one record in the table.
Expected output: A single document containing the console output, return status from tbuild and the script which the Snap submitted to tbuild.

Prerequisites:

TPT Snaps (TPT Insert, TPT Update, TPT Delete, TPT Upsert and TPT Load) uses the 'tbuild' utility for the respective operations.

In order to use these Snaps in the pipelines, the respective TPT utilities should be installed/available on the Snapplexes.

All the required TPT utilities must be installed on the node where JCC is running or the Snap simply executes but may not perform the operation. Any utility/library file missing on the node may cause the Snap to perform a failed operation.

Basic steps for installing the TPT utilities:

Procedure to install the Teradata tools and utilities:

Download the Teradata Tools and Utilities base such as TTU 16.20.25.00 Linux - Base for Linux environment.
If the OS is 64 bit, install 32 bit support packages on the environment and also any further dependencies
Install the Teradata Tools and Utilities (that includes tbuild, fastload, mload etc)
The default installation also configures the PATH in the OS

Flow: If tbuild or fastload is already available in the OS path then the corresponding TPT Snap can call the utility, however, if these binaries are not available in the OS path, then we need to provide the absolute path of the respective binary in the Snap.

Support and limitations:

To support UTF-8 in TPT Load Snap:

Enter the CHARSET=UTF8 under Url properties in Teradata account.
Create the text-type columns in the target table as UNICODE. For example, CREATE TABLE <target table name> (field2 VARCHAR(100) CHARACTER SET UNICODE).
TBUILD utility used by TPT Load Snap limits the size of the text-type columns to 32,000. For example, for LONG VARCHAR column, the input values should be less than or equal to 32,000 bytes. If this limit is exceeded, TBUILD throws an exception and TPT Load Snap writes the error to the error view. If input strings have single-byte special characters from 0x90 to 0xFF, those characters are counted as two bytes each.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Configuring Teradata Database Accounts for information on setting up this type of account.

Views:

Input

This Snap has two input views but by default it has one input view.
You can add a second view for metadata for the table as a document so that the table is created in MySQL with a similar schema as the source table. This schema is usually from the second output of a database Select Snap. If the schema is from a different database, the data types might not be properly handled.

Output

This Snap has one output view. The output view produces three output fields, the Script, Status and the Out.

SCRIPT: Specifies the script generated by the Snap and will be executed in the OS (the password will be masked)
STATUS: Specifies the status after executing the Snap (produced from the fastload execution), the status contains the number of records read, a number of records inserted and a number of records rejected.
OUT: Specifies the output text/data captured from the execution of the FastLoad program.

Error

This Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label*

Specify the name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Schema name

Specify the database schema name. In case it is not defined, the suggestion for the table name will retrieve all the table names of all the schemas. The property is suggestible and will retrieve available database schemas during suggest values.

The values can be passed using the pipeline parameters but not the upstream parameter.

Default value: None
Example: SYS

Table name*

Specify the name of the table to insert records into.

The values can be passed using the pipeline parameters but not the upstream parameter.

Default value: None
Example: people

Create table if not present

Select this checkbox to automatically create the target table if it does not exist.

If a second input view is configured for the Snap and it contains a document with schema (metadata) from the source table, the Snap creates the new (target) table using the same schema (metadata). However, if the schema comes from a different database, the Snap might fail with the Unable to create table: "<table_name>" error due to data type incompatibility.
In the absence of a second input view, the Snap creates a table based on the data types of the columns generated from the first row of the input document (first input view).

Due to implementation details, a newly created table is not visible to subsequent database Snaps during runtime validation. If you want to immediately use the newly updated data you must use a child Pipeline that is invoked through a Pipeline Execute Snap.

Default value: Not selected

TBUILD location

Specify the absolute path for fastload command. If this field is left blank then the Snap tries to load the fastload command from the Operating System.

Default value: None

Write error table records to error view

Select this check box to write all the records from the error tables to an error view after a fast load execution.

Default value: Not selected

Fetch metadata delay (seconds)

Specify the wait time in seconds to be used before fetching metadata to avoid conflicts while performing Teradata parallel executions in a pipeline.

Default value: 0

Delete table data if present

Select this check box to delete the table data if present.

If selected, the data will be deleted from the table before loading.

If not selected, it displays an error to ensure the table is empty and not locked.

Default value: Not selected

Query band

Specify the name-value pairs to use in the session's generated query band statement. The query band is passed to the Teradata database as a list of name-value pairs separated by semi-colons.

Default Value: N/A
Example: ProjectName=dstage1;user=test;

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error Reason Resolution

Failure: TPT script failed to execute

error code: 8

The Snap is unable to read the Fastload absolute path.

Leave the field blank or update the Fastload absolute path with .exe extension to prevent your pipeline from failing.

For example, if you used /usr/bin/fastloadas the Fastload absolute path, change it to /usr/bin/fastload.exe.

Failure: Failed to execute query

error code: 5992

A syntax error was found in the QUERY_BAND.

Check that the query band is in the form specified in the Query band field above.

For example, if you used priority=1;workload=high in the Query band, add a semi-colon and update the value to priority=1;workload=high;.

Example

This pipeline passes values into a table on TPT and writes the records to an output view.

1. The JSON Generator Snap passes the input values to the TPT table via the Mapper Snap.

2. The upstream Mapper Snap maps the values to be added to the records on TPT table.

3. The TPT Load Snap loads the data into the table INTERGERtable.

Note the Fetch metadata delay has been set to 5 secs, which means the Snap waits for 5 seconds before fetching the metadata. This value should be set to a proper value to avoid conflicts while performing Teradata parallel executions in a pipeline. For example, where one Snap is trying to create a table and the next Snap is trying to access the table even before the table is created, or, the Snap is trying to write the records to the output view even before the data is recorded onto the table (even before the previous Snap finishes its job).

4. The successful execution of the pipeline displays the below output for the TPT Load Snap:

The Teradata Execute Snap writes the records to the output view as below:

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
November 2024	439patches29297	20 Dec 2024	Latest	Enhanced the following Teradata Snaps with the Query band field that logs the SnapLogic pipeline, project, and Teradata database information in Teradata to help associate metadata with each query when it is executed: TPT FastExport Teradata FastExport Teradata FastLoad Teradata Select Teradata Execute TPT Load
November 2024	439patches29265	05 Dec 2024	Latest	Fixed an issue with the Teradata FastLoad Snap that validated successfully even when the fast load was paused due to an error. The Snap now displays the error with the appropriate reason for the pause. Fixed an issue with the Teradata FastLoad Snap where an invalid output document was generated when an error occurred while fetching the table schema, and the Create table if not present, checkbox is deselected. Now, the Snap correctly displays an error in such cases, regardless of the checkbox status.
November 2024	main29029	13 Nov 2024	Stable	Updated and certified against the current SnapLogic Platform release.
August 2024	438patches29017	12 Nov 2024	Latest	Fixed an issue with the Teradata Snaps that caused errors because of invalid account credentials when the username or password included any of the following special characters: ) ( ! \ # $ % ^ & * " ' ? \| ; ~ -`
August 2024	main27765	21 Aug 2024	Stable	Upgraded the `org.json.json` library from v20090211 to v20240303, which is fully backward compatible.
May 2024	437patches26471	10 Jun 2024	Latest	The jOOQ library for Teradata Snap Pack is upgraded from v3.9.1 to v3.17.3. This upgrade will be part of the GA release on August 14, 2024 (Stable release). Pipelines using the Teradata Snaps are not impacted after the jOOQ upgrade.
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	The Teradata Execute Snap now includes a new Query type field. When Auto is selected, the Snap tries to determine the query type automatically.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	The TPT Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met: The Create table if not present checkbox is selected. The target table does not exist. The table metadata is provided in the second input view.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29 Patch	429patches16235	21 Jul 2022	Latest	Fixed an issue with Teradata Execute Snap where the Snap did not display valid error message when the delete condition is invalid.
4.29	main15993	14 May 2022	Stable	Enhanced the Teradata FastExport Snap with Character Set dropdown list to support encoding of data when you export data from the Teradata Database.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27	main12833	13 Nov 2021	Stable	Enhanced the Teradata Execute Snap to invoke stored procedures.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25 Patch	425patches11008	04 Aug 2021	Latest	Improved the error messages for all the Snaps in the Teradata Snap Pack where the Snaps fail with a null pointer exception error when the account reference provided is invalid.
4.25	main9554	08 May 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.24 Patch	424patches8799	05 Mar 2021	Latest	Enhanced the Teradata Execute Snap by adding a new field, Advanced options, which extends support with microsecond precision for TIMESTAMP data type. Fixed an issue in the TPT Load Snap where the Snap failed to load data into the table while creating an output. Fixed an issue with the TPT Load Snap wherein now a null value is loaded as null and empty string is loaded as empty string. This fix may cause existing pipelines to fail if empty string values are expected to be loaded as null. Following are the new configurations: `VARCHAR QuotedData= Optional` `VARCHAR OpenQuoteMark= \”` `VARCHAR NullColumns= Yes`
4.24	main8556	13 Feb 2021	Stable	Enhanced the Teradata Select Snap to return only the selected output fields or columns in the output schema (second output view) using the Fetch Output Fields In Schema check box. If the Output Fields field is empty all the columns are visible.
4.23	main7430	14 Nov 2020	Stable	Fixes the multi-line value issue and issue in the TPT Load Snap where the Snap writes null for both an empty string and null values in the input data. The fix for this issue was to add the following three lines in the script and wrap all the values in double quotes unless they are null while writing the input data into a temp CSV file. VARCHAR QuotedData = 'Optional', VARCHAR OpenQuoteMark = '\"' VARCHAR NullColumns = 'Yes' This fix may cause existing pipelines to fail if empty string values are expected to be loaded as null.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21 Patch	421patches6272	27 Jul 2020	Latest	Fixed the issue where Snowflake SCD2 Snap generates two output documents despite no changes to Cause-historization fields with DATE, TIME and TIMESTAMP Snowflake data types, and with Ignore unchanged rows field selected.
4.21 Patch	421patches6144	20 Jul 2020	Latest	Fixed the following issues with DB Snaps: The connection thread waits indefinitely causing the subsequent connection requests to become unresponsive. Connection leaks occur during Pipeline execution.
4.21 Patch	MULTIPLE8841	19 May 2020	Latest	Fixed the connection issue in Database Snaps by detecting and closing open connections after the Snap execution ends.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19 Patch	db/teradata8414	13 Dec 2019	Latest	Fixed an issue with the TPT Update Snap wherein the Snap is unable to perform operations when: An expression is used in the Update condition property. Input data contain the character '?'.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Fixed an issue with the Teradata Execute Snap wherein the Snap would send the input document to the output view even if the Pass through field is not selected in the Snap configuration. With this fix, the Snap sends the input document to the output view, under the key original, only if you select the Pass through field. Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15 Patch	db/teradata6338	05 Dec 2018	Latest	Replaced Max idle time and Idle connection test period properties with Max life time and Idle Timeout properties respectively, in the Account configuration. The new properties fix the connection release issues that were occurring due to default/restricted DB Account settings.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10	snapsmrc414	12 Aug 2017	Stable	Added Auto commit property to the Select and Execute Snaps at the Snap level to support overriding of the Auto commit property at the Account level.
4.9.0 Patch	teradata3077	01 Jun 2017	Latest	Fixed an issue regarding connection not closed after login failure; Expose autocommit for "Select into" statement in PostgreSQL Execute Snap and Redshift Execute Snap
4.9	snapsmrc405	13 May 2017	Stable	Enhanced the Output view of the Snap with Order Summary field that displays the output values (added to the out, err, status, classpath and env fields of the single output view that display the subprocess only). Teradata Export to HDFS Snap supported with Dynamic account.
4.8	snapsmrc398	11 Feb 2017	Stable	Introduced the TPT Delete, Insert, Load, Upsert and Update Snaps in this release. Introduced Teradata Export to HDFS Snap in this release. Info tab added to accounts. Database accounts now invalidate connection pools if account properties are modified and login attempts fail.
4.7	snapsmrc382	23 Nov 2016	Stable	Introduced the Teradata FastLoad and Execute Snaps in this release. Migration impact: In Teradata FastExport, the values of the Data Format field have been standardized to be in all caps. Existing pipelines that use the values of Binary, Text, or Unformatted will fail unless the new value of BINARY, TEXT, or UNFORMAT are used.
4.6	snapsmrc362	13 Aug 2016	Stable	Snap Pack introduced in 4.6.0. This includes only Teradata extract functionality to move data out of Teradata database using the FastExport Utility. It does not include Snaps for load, select, insert, delete, execute or others at this time. It also does not utilize the Teradata Parallel Transporter to extract data.