teradataml UDF Prerequisites | Teradata Package for Python - teradataml UDF Prerequisites - Teradata VantageCloud Lake

Lake - Analyze Your Data with ClearScape Analytics™

Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2026-02-20
dita:mapPath
tcl1683670667798.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
tcl1683670667798

UDF functions are executed using Apply table operator (Open Analytics Framework). For Apply table operator setup, refer to Complete Prerequisites to Use Open Analytics Framework.

UDF functions support all Vantage platforms where the appropriate table operator is supported.

Database Engine 20 supports Apply Table Operator (Open Analytics Framework)

  • Once you create the environment, configure it to be used by teradataml UDF functions. Refer to Working with Open Analytics for setup and environment creation details.
    from teradataml import configure
    configure.openml_user_env = <Object of UserEnv class>
  • If you don't specify a configuration option, teradataml UDF uses default openml_env, an Open Analytics Framework environment for execution. This default environment has the latest Python supported by Open Analytics Framework at the time of creating the environment.
  • Required modules/packages to run the user defined function must be installed in a remote user environment while executing teradataml UDF on VantageCloud Lake.
  • While working on date and time data types, you must format these to the supported formats. Refer to Requisite Input and Output Structures.