Teradata Package for Python Function Reference on VantageCloud Lake - deregister - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.

Teradata® Package for Python Function Reference on VantageCloud Lake

Deployment
VantageCloud
Edition
Lake
Product
Teradata Package for Python
Release Number
20.00.00.03
Published
December 2024
ft:locale
en-US
ft:lastEdition
2024-12-19
dita:id
TeradataPython_FxRef_Lake_2000
Product Category
Teradata Vantage
teradataml.dataframe.functions.deregister = deregister(name, returns=None)
DESCRIPTION:
    Deregisters a user defined function (UDF).
 
PARAMETERS:
    name:
        Required Argument.
        Specifies the name of the user defined function to deregister.
        Types: str
 
    returns:
        Optional Argument.
        Specifies the type used to deregister the user defined function.
        Types: teradatasqlalchemy types object
 
RETURNS:
    None
 
RAISES:
    TeradataMLException.
 
EXAMPLES:
    # Example 1: Register the user defined function to get the values in lower case,
    #            then deregister it.
    >>> @udf
    ... def to_lower(s):
    ...   if s is not None:
    ...        return s.lower()
 
    # Register the created user defined function.
    >>> register("lower", to_lower)
 
    # List all the UDFs registered
    >>> list_udfs(True)
    id      name  return_type                                          file_name
     0     lower  VARCHAR1024  tdml_udf_name_lower_udf_type_VARCHAR1024_register.py
     1     upper  VARCHAR1024  tdml_udf_name_upper_udf_type_VARCHAR1024_register.py
     2  add_date         DATE   tdml_udf_name_add_date_udf_type_DATE_register.py
     3  sum_cols      INTEGER  tdml_udf_name_sum_cols_udf_type_INTEGER_register.py
    >>>
 
    # Deregister the created user defined function.
    >>> deregister("lower")
 
    # List all the UDFs registered
    >>> list_udfs(True)
    id      name  return_type                                          file_name
     0     upper  VARCHAR1024  tdml_udf_name_upper_udf_type_VARCHAR1024_register.py
     1  add_date         DATE   tdml_udf_name_add_date_udf_type_DATE_register.py
     2  sum_cols      INTEGER  tdml_udf_name_sum_cols_udf_type_INTEGER_register.py
    >>>
 
    # Example 2: Deregister only specified udf function with it return type.
    >>> @udf(returns=FLOAT())
    ... def sum(x, y):
    ...    return len(x) + y
 
    # Deregister the created user defined function.
    >>> register("sum", sum)
 
    # List all the UDFs registered
    >>> list_udfs(True)
    id name return_type                                       file_name
     0  sum       FLOAT    tdml_udf_name_sum_udf_type_FLOAT_register.py
     1  sum     INTEGER  tdml_udf_name_sum_udf_type_INTEGER_register.py
     >>>
 
    # Deregister the created user defined function.
    >>> from teradatasqlalchemy import FLOAT
    >>> deregister("sum", FLOAT())
 
    # List all the UDFs registered
    >>> list_udfs(True)
    id name return_type                                       file_name
     0  sum     INTEGER  tdml_udf_name_sum_udf_type_INTEGER_register.py
     >>>