tweakstreet-logo
  • Enter search terms

SQL Script

Runs SQL queries and retrieves results for each query

Processing

For every input row, the step executes a SQL script and provides the query results in step results.

Settings

Name Type Description
Connection
 dict

The database connection to use.

Evaluated for each input row
SQL
 string

The SQL queries executed.

Can be supplied as one of the following:

  • a single string - in this case individual statements must be separated by blank lines
  • a list of strings - in this case each item is a separate statement

Evaluated for each input row
Jdbc Parameters
 list

JDBC Parameters

Each parameter is bound to ? placeholders in the SQL script in order of appearance.

Evaluated for each input row
Get Generated Keys
 boolean

If enabled, attempt to get generated keys for inserted rows.

Evaluated for each input row
On Errors
 string

Determines action when query execution fails.

  • error: aborts execution of sql script and generates an error row
  • warn: logs a warning, and continues with subsequent sql statements
  • ignore: ignores the error and continues with subsequent sql statements

Evaluated for each input row

Results

Name Type Description
data
 list

List holding the results for all executed queries in order.

Each entry in the list is a dict with a :type key identifying the query result type. The following types are possible:

Update Count Results

The query returned a number indicating the number of rows changed by the query. If “Get Generated Keys” is enabled, generated keys for inserted values are present.

The shape of the dict is:

Key Type Value
type
 string "update_count"
update_count
 long the number of rows changed by the query
generated_keys
 list list of long values, each a generated key for an inserted row
Result Set Results

The query returned a result set with database records.

The shape of the dict is:

Key Type Value
type
 string "result_set"
meta
 list List of dicts describing fields in the returned records. Each entry has a :name and :type key.
rows
 list List of dicts representing returned records.
Error Results

The query has resulted in an error.

The shape of the dict is:

Key Type Value
type
 string "error"
message
 string The error message as provided by the database system.
On this page