API description

NZFunApply

NZFunApply(self, df,  output_signature, output_table=None, fun_ref=None, code_str=None,  fun_name=None, merge_output_with_df=False, id=’ID’):
df: IdaDataFrame
Pointer to the database table.
parallel:Boolean
Parallel if True would run the function on the default data slices and if False would run the function on the host.
output_signature:dict

The result of the function. This is a Python dictionary format (key-value pairs for the column names and output types). Accepted output types are ‘int’, ‘double’, ‘str’, ‘float’.

Example:
{‘output_result_column1’: ’int’, ‘output_result_column2’: ‘str’}
output_table:str, default=None
Creates a new table with the result.
fun_ref: str, default=None
The function reference that is supplied with function name. Some Notebook environments might not allow source code retrieval that is using function names. In such scenarios, code_str:str, default=None and fun_name:str, default:None are needed.
code_str:str, default=None
The variable that holds the function code in quotes.
fun_name:str, default:None
The name of the function which is needed when code_str is used.
merge_output_with_df:Boolean, default=False
If True merges the function output columns with the original data frame columns.
id, default =’ID’
The name of the identity column.

NZFunTApply

NZFunTApply(df,  parallel,  output_signature=None, output_table=None, fun_ref=None, code_str=None, fun_name=None,  merge_output_with_df=False, id=’ID’)
df: IdaDataFrame
Pointer to the database table.
parallel:Boolean
Parallel if True would run the function on the default data slices. If False would run the function on the host
output_signature:dict

The result of the function. This is a Python dictionary format (key-value pairs for the column names and output types). Accepted output types are ‘int’, ‘double’, ‘str’, ‘float’.

Example:
{‘output_result_column1’: ’int’, ‘output_result_column2’: ‘str’}
output_table:str, default=None
Creates a new table with the result.
fun_ref: str, default=None
The function reference (supplied with function name). Some Notebook environments might not allow source code retrieval that is using function names. In such scenarios, next code_str:str, default=Noneand fun_name:str, default:None are needed.
code_str:str, default=None
The variable that holds the function code in quotes.
fun_name:str, default:None
The name of the function which is needed when code_str is used.
merge_output_with_df:Boolean, default=False
If True will merge the function output columns with the original dataframe columns.
id, default='ID'
The name of the identity column.

NZFunGroupedApply

NZFunGroupedApply(df, index, output_signature, output_table=None, fun_ref=None,  code_str=None,  fun_name=None,  merge_output_with_df=False, id=’ID’)
df: IdaDataFrame
Pointer to the database table
index:str
Name of column that the user wants partitions to be computed from.
output_signature:dict
The result of the function. This is a Python dictionary format (key-value pairs for the column names and output types). Accepted output types are ‘int’, ‘double’, ‘str’, ‘float’.
Example:
{‘output_result_column1’: ’int’, ‘output_result_column2’: ‘str’}
output_table:str, default=None
Creates a new table with the result.
fun_ref: str, default=None
The function reference (supplied with function name). Some notebook environments may not allow source code retrieval using function names. In such scenarios, next two arguments are needed.
code_str:str, default=None
The variable that holds the function code in quotes.
fun_name:str, default:None
The name of the function which is needed when code_str is used.
merge_output_with_df:Boolean, default=False
If True will merge the function output columns with the original dataframe columns.
id, default='ID'
The name of the identity column.

NZInstall

NZInstall(package_name):
package_name:str
The Python package name to be installed.