set_config_params | Teradata Package for Python - set_config_params - 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

Use the set_config_params function to set the configurations in Vantage.

Alternatively, you can set the configuration parameters independently using the teradataml.configure module.

Optional arguments "kwargs" specifies keyword arguments:

certificate_file
Specifies the path of the certificate file, which is used in encrypted REST service calls.
default_varchar_size
Specifies the size of varchar datatype in Vantage.

The default size is 1024.

vantage_version
Specifies the version of the Vantage system teradataml is connected to.
val_install_location
Specifies the database name where Vantage Analytic Library (VAL) functions are installed.
byom_install_location
Specifies the database name where Bring Your Own Model (BYOM) functions are installed.
database_version
Specifies the database version of the system teradataml is connected to.
read_nos_function_mapping
Specifies the function mapping name for the READ_NOS table operator function.
write_nos_function_mapping
Specifies the function mapping name for the WRITE_NOS table operator function.
inline_plot
Specifies whether to display the plot inline or not.
This option is not applicable for machines running linux and mac os.
openml_user_env
Specifies the user environment to be used for OpenML.
local_storage
Specifies the location on the client where garbage collector folder will be created.
stored_procedure_install_location
Specifies the name of the database where stored procedures are installed.
table_operator
Specifies the name of the table operator.

Permitted values: "Apply, "Script".

temp_object_type
Specifies the type of temporary database objects created internally by teradataml.

Permitted Values: * "VT" - Volatile tables.

If this option is set to "VT" and "persist" argument of analytic functions is set to True, then volatile tables are not created as volatile table cannot be persisted and "persist" argument takes precedence.

Example 1: Set configuration parameters using set_config_params() function

>>> from teradataml import set_config_params
>>> set_config_params(auth_token="abc-pqr-123",
...                   ues_url="https://teracloud/v1/accounts/xyz-234-76085/open-analytics",
...                   certificate_file="cert.crt",
...                   default_varchar_size=512,
...                   val_install_location="VAL_USER",
...                   sandbox_container_id="bgf1233csdh123",
...                   read_nos_function_mapping="read_nos_fm",
...                   write_nos_function_mapping="write_nos_fm",
True

Example 2: Set configuration parameters using configure module

>>> from teradataml import configure
>>> configure.auth_token="abc-pqr-123"
>>> configure.ues_url="https://teracloud/v1/accounts/xyz-234-76085/open-analytics"
>>> configure.certificate_file="cert.crt"
>>> configure.default_varchar_size=512
>>> configure.val_install_location="VAL_USER"
>>> configure.sandbox_container_id="bgf1233csdh123"
>>> configure.read_nos_function_mapping="read_nos_fm"
>>> configure.write_nos_function_mapping="write_nos_fm"