Database Variables

Unless otherwise noted, these built-in runtime variables can be used for all database data sources and sinks. All of these variables are optional.

In JSON node files, these variables may be used in configuring the keys (steps) within a step or source/sink mapping definition.

See Built-In Runtime Variables for the variables used in configuring the node or source/sink, itself, and for testing wildcard mappings.

Access runtime variables

Runtime variables can be found in the Mappings tab of the Node Editor and in the JSON file of the File Editor.

Runtime variables

Runtime variables for database source and sink mappings/steps

Runtime variables field in the UI	Runtime variables field in JSON	Description and details
Row Count	row_count	Specifies the variable that stores the number of rows in an input or output dataset. Availability: Database sources where query-type is execute_query and database sinks where query-type is either execute_dml or bulk_insert. Value type: string Node file: Recorded in /data_sources/source.json and/or /data_sinks/sink.json.
Column Count	column_count	Specifies the variable that stores the number of columns in an input or output dataset. Availability: Availability: Database sources where query-type is execute_query and database sinks where query-type is bulk_insert Value type: string Node file: Recorded in /data_sources/source.json and/or /data_sinks/sink.json.
Scalar Result	result	Specifies the variable that stores the scalar export content of data sources. Availability: Database sources where query-type is execute_scalar; not available for Salesforce data sources. Value type: string Node file: Recorded in /data_sources/source.json and/or /data_sinks/sink.json.

Warning

Row count test results may not match. When row_count variables are used with file-based data sources and sinks, the resulting value includes a header row if one is present. Conversely, when row_count variables are used with database sources and sinks, the resulting value does not count the header row when database table headers are present. A database table header row is only included in the data set if the property key insert-column-names is set to "true."

Warning

UTF-8 file encoding is required. Files used with data sources and data sinks must be encoded in UTF-8 in order to avoid non-Unicode characters causing problems with sinking data to database tables and errors when running related tests. For CSV and other delimited files, use the "save as" function in your application and select the proper encoding, or consider using a text editor with encoding options.