Parameters

Teradata Developer Guides

ft:locale
en-US
ft:lastEdition
2026-08-18
Name Type Description Default Value Required
Configuration String The name of the configuration to use x
Transactional Action Enumeration, one of:
ALWAYS_JOIN
JOIN_IF_POSSIBLE
NOT_SUPPORTED
The type of joining action that operations can take regarding transactions JOIN_IF_POSSIBLE
Query Timeout Number Indicates the minimum amount of time before the JDBC driver attempts to cancel a running statement. By default, no timeout is used. 0
Query Timeout Unit Enumeration, one of:
NANOSECONDS
MICROSECONDS
MILLISECONDS
SECONDS
MINUTES
HOURS
DAYS
A time unit that qualifies the #queryTimeout. Values specified in nanoseconds, microseconds, or milliseconds are rounded to seconds. SECONDS
Fetch Size Number Indicates how many rows to fetch from the database when rows are read from a ResultSet. 10
Max Rows Number Sets the limit for the maximum number of rows that any ResultSet object generated by this message processor can contain for the given number. If the limit is exceeded, the excess rows are silently dropped.
SQL Query Text String The text of the SQL query to execute x
Parameter Types Array of Parameter Type Allows you to optionally specify the type of one or more of the parameters in the query. If provided, you're not required to reference all of the parameters; but you cannot reference a parameter that is not present in the input values.
Input Parameters Object A map in which keys are the name of an input parameter to be set on the JDBC prepared statement. Each parameter should be referenced in the SQL text using a colon prefix (E.g: where id = :myParamName). The map's values contain the actual assignation for each parameter.
Auto Generate Keys Boolean Indicates when to make auto-generated keys available for retrieval. false
Auto Generated Keys Column Indexes Array of Number List of column indexes that indicates which auto-generated keys to make available for retrieval
Auto Generated Keys Column Names Array of String List of column names that indicates which auto-generated keys to make available for retrieval
Target Variable String The name of a variable to store the operation's output
Target Value String An expression to evaluate against the operation's output and store the expression outcome in the target variable #[payload]
Reconnection Strategy Reconnect
Reconnect Forever
A retry strategy in case of connectivity errors