Teradata Package for Python Function Reference | 20.00 - list_td_reserved_keywords - 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 - 20.00

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Teradata Package for Python
Release Number
20.00
Published
March 2024
Language
English (United States)
Last Update
2024-04-10
dita:id
TeradataPython_FxRef_Enterprise_2000
Product Category
Teradata Vantage
teradataml.dbutils.dbutils.list_td_reserved_keywords = list_td_reserved_keywords(key=None, raise_error=False)
DESCRIPTION:
    Function validates if the specified string is Teradata reserved keyword or not.
    If key is not specified, list all the Teradata reserved keywords.
 
PARAMETERS:
    key:
        Optional Argument.
        Specifies a string to validate for Teradata reserved keyword.
        Types: string
 
    raise_error:
        Optional Argument.
        Specifies whether to raise exception or not.
        When set to True, an exception is raised,
        if specified "key" is a Teradata reserved keyword, otherwise not.
        Default Value: False
        Types: bool
 
RETURNS:
    teradataml DataFrame, if "key" is None.
    True, if "key" is Teradata reserved keyword, False otherwise.
 
RAISES:
    TeradataMlException.
 
EXAMPLES:
   >>> from teradataml import list_td_reserved_keywords
   >>> # Example 1: List all available Teradata reserved keywords.
   >>> list_td_reserved_keywords()
     restricted_word
   0             ABS
   1         ACCOUNT
   2            ACOS
   3           ACOSH
   4      ADD_MONTHS
   5           ADMIN
   6             ADD
   7     ACCESS_LOCK
   8    ABORTSESSION
   9           ABORT
   >>>
 
   >>> # Example 2: Validate if keyword "account" is a Teradata reserved keyword or not.
   >>> list_td_reserved_keywords("account")
   True
   >>>
 
   >>> # Example 3: Validate and raise exception if keyword "account" is a Teradata reserved keyword.
   >>> list_td_reserved_keywords("account", raise_error=True)
   TeradataMlException: [Teradata][teradataml](TDML_2121) 'account' is a Teradata reserved keyword.