supports a set of variables, which can be used to programmatically reference aspects of the dataset or its source data. These metadata references allow you to create individual transformations of much greater scope and flexibility.
Tip: Some transformation steps make access to metadata about the original data source impossible to retain. It's best to use these references, where possible, early in your recipe. Additional information is available below.
Tip: You can use the
This reference retrieves the fully qualified path for a row of data sourced from a file. As you are working with a dataset in the application, it can be helpful to know where the file from which each row of data originated. Using the
$filepath function, you can generate columns of data early in your recipe to retain this useful information.
The following transforms might make file path information invalid or otherwise unavailable:
NOTE: This reference returns the file path. It does not include the scheme or authority information from the URI. So, protocol identifiers such as
NOTE: For Avro sources, if you imported a folder containing multiple Avro files, the folder path is returned. The full path is returned for single Avro files and for other multi-file datasets.
Base file formats:
Full path to the converted CSV file on backend datastore is returned, which is a temporary location. Original XLSX file path is not available.
|Compressed files (Gzip, Bzip2, etc)||Limited||Support for single-file archives only. Full path is returned only if the archive contains a single file.|
|folders||Yes||Full path to the file is returned. You can modify the output column to return the folder path only.|
The following example generates a column containing the filepath information for each row in the dataset:
derive type: single value: $filepath as: 'src_filepath'
You can use the following additional steps to extract the filename from the above
derive type: single value: RIGHTFIND(src_filepath, '\/', false, 0) as: 'rightfind__src_filepath'
derive type: single value: SUBSTRING(src_filepath, rightfind_src_filepath + 1, LEN(src_filepath)) as: 'filename'
drop col: rightfind_src_filepath action: Drop
$sourcerownumber variable is a reference to the row number in which the current row originally appeared in the source of the data.
The following transforms might make original row information invalid or otherwise unavailable. In these cases, the reference returns null values:
NOTE: If the dataset is sourced from multiple files, a predictable original source row number cannot be guaranteed, and null values are returned.
Tip: If the source row information is still available, you can hover over the left side of a row in the data grid to see the source row number in the original source data.
The following example generates a new column containing the source row number for each row in the dataset, if available:
derive type: single value: $sourcerownumber as: 'src_rownumber'
If you have already used the
$filepath reference, as in the previous example, you can combine these two columns to create a unique key to the source of each row:
derive type: single value: MERGE([src_filename,src_rownumber],'-') as: 'src_key'
$col variable is a reference to the column that is currently being evaluated. This variable references the state of the current dataset, instead of the original source.
In the following example, all columns in the dataset that are of String type are converted to uppercase:
set col: * value: IF(ISMISMATCHED($col, ['String']), $col, UPPER($col))
In the above, the wildcard applies the edit to each column. Each column is tested to see if it is mismatched with the String data type. If mismatched, the value in the column (
$col) is written. Otherwise, the value in the column is converted to uppercase (