Use the script.Ui constructor to open the Script Table Operator UI in the notebook.
Required Parameters
- search_path
- Specifies the database search path for the SCRIPT execution.
- data
- Specifies a teradataml DataFrame containing the input data for the script.
Optional Parameters
- default_database
- Specifies the default database.
- connection
- Specifies the specific connection; could be teradataml based (i.e., TeradatamlConnection instance) or another platform.
- script_name
- Specifies the name of user script. User script should have at least permissions of mode 644.
- files_local_path
- Specifies the absolute local path where user script and all supporting files like model files, input data file reside.
- script_command
- Specifies the command/script to run.
- delimiter
- Specifies a delimiter to use when reading columns from a row and writing result columns.
The default value is "\t" (tab)
- "delimiter" cannot be the same as "quotechar".
- "delimiter" cannot be a newline character, i.e., '\\n'.
- returns
- Specifies output column definition.You can pass a dictionary (dict or OrderedDict) to "returns", with the keys ordered to represent the order of the output columns.
Teradata recommends using OrderedDict.
- auth
- Specifies an authorization to use when running the script.
- charset
- Specifies the character encoding for data.
Permitted values are utf-16, latin.
- quotechar
- Specifies a character that forces all input and output of the script to be quoted using this specified character. This parameter enables the database to distinguish between NULL fields and empty strings. A string with length zero is quoted, while NULL fields are not. If this character is found in the data, it will be escaped by a second quote character.
- "quotechar" cannot be the same as "delimiter" argument.
- "quotechar" cannot be a newline character, i.e., '\\n'.
- data_partition_column
- Specifies Partition By columns for "data".
Values to this parameter can be provided as a list, if multiple columns are used for partition.
- "data_partition_column" cannot be specified along with "data_hash_column".
- "data_partition_column" cannot be specified along with "is_local_order = True".
- data_hash_column
- Specifies the column to be used for hashing. The rows in the data are redistributed to AMPs based on the hash value of the column specified. The user-installed script file then runs once on each AMP. If there is no "data_partition_column", then the entire result set, delivered by the function, constitutes a single group or partition."data_hash_column" cannot be specified along with "data_partition_column", "is_local_order", and "data_order_column".
- data_order_column
- Specifies Order By columns for "data". Values to this argument can be provided as a list, if multiple columns are used for ordering. This argument is used with in both cases: "is_local_order = True" and "is_local_order = False"."data_order_column" cannot be specified along with "data_hash_column".
- is_local_order
- Specifies a boolean value to determine whether the input data is to be ordered locally or not. Order by specifies the order in which the values in a group, or partition, are sorted. Local Order By specifies orders qualified rows on each AMP in preparation to be input to a table function. This argument is ignored, if "data_order_column" is None. When set to True, data is ordered locally.
- "is_local_order" cannot be specified along with "data_hash_column".
- When "is_local_order" is set to True, "data_order_column" should be specified, and the columns specified in "data_order_column" are used for local ordering.
- sort_ascending
- Specifies a boolean value to determine if the result set is to be sorted on the "data_order_column" column in ascending or descending order. The sorting is ascending when this argument is set to True, and descending when set to False. This argument is ignored, if "data_order_column" is None.
- nulls_first
- Specifies a boolean value to determine whether NULLS are listed first or last during ordering. This argument is ignored, if "data_order_column" is None. NULLS are listed first when this argument is set to True, and last when set to False.