teradataml 20.0.0.0__py3-none-any.whl → 20.0.0.1__py3-none-any.whl

teradataml/clients/auth_client.py

@@ -0,0 +1,133 @@
+"""
+Unpublished work.
+Copyright (c) 2024 by Teradata Corporation. All rights reserved.
+TERADATA CORPORATION CONFIDENTIAL AND TRADE SECRET
+Primary Owner: gouri.patwardhan@teradata.com
+Secondary Owner: Pradeep.Garre@teradata.com
+This file implements workflow for generating JWT token.
+"""
+import base64
+import jwt
+import time
+from pathlib import Path
+import pathlib
+from teradataml import configure
+
+class _AuthWorkflow:
+    """
+    Get the JWT token for requested user.
+    """
+    def __init__(self, state):
+        """
+        DESCRIPTION:
+            Constructor to initiate Authentication work flow.
+
+        PARAMETERS:
+            state:
+                Required Argument.
+                Specifies the dictionary containing following:
+                    1. "base_url" which is extracted from "ues_url".
+                    2. "org_id" which is also extracted from "ues_url".
+                    3. "pat_token" which is obtained from VantageCloud Lake Console, and it is specific to the user.
+                    4. "pem_file" which is obtained from VantageCloud Lake Console, and it is specific to the user.
+                    5. "username" which is the DB user.
+                    5. "expiration_time" which is the expiration time for the token and has a default value of
+                       31536000 seconds.
+                Types: dict
+
+        RETURNS:
+            Instance of _AuthWorkflow.
+
+        RAISES:
+            None
+
+        EXAMPLES :
+            >>> _AuthWorkflow(state)
+        """
+        self.state = state
+
+    def _get_epoch_time(self):
+        """
+        DESCRIPTION:
+            Generate expiry epoch time.
+
+        RETURNS:
+            float
+        """
+        current_epoch_time = int(time.time())
+        expiry_epoch_time = current_epoch_time + self.state.get('expiration_time')
+        return current_epoch_time, expiry_epoch_time
+
+    def _generate_header(self):
+        """
+        DESCRIPTION:
+            Generate JWT header.
+
+        RETURNS:
+            dict
+        """
+        # Extract the pem file name without extension.
+        kid = pathlib.Path(self.state.get('pem_file')).stem
+        header = {
+            "alg": "RS256",
+            "kid": kid,
+            "typ": "JWT"
+        }
+        return header
+
+    def _generate_payload(self):
+        """
+        DESCRIPTION:
+            Generate JWT payload.
+
+        RETURNS:
+            A dictionary with the JWT payload.
+        """
+        iat, exp= self._get_epoch_time()
+        payload = {
+            "aud": [
+                "td:service:authentication"
+            ],
+            "iat": iat,
+            "exp": exp,
+            "iss": "teradataml",
+            "multi-use": True,
+            "org_id": self.state['org_id'],
+            "pat": self.state['pat_token'],
+            "sub": self.state['username']
+        }
+        return payload
+
+    def _sign_jwt(self, payload, header):
+        """
+        DESCRIPTION:
+            Encode JWT using private key.
+
+        PARAMETERS:
+            payload:
+                Required Argument.
+                Specifies the payload required for encoding the JWT token.
+                Types: dict
+            header:
+                Required Argument.
+                Specified the header required for encoding the JWT token.
+                Types: dict
+
+        RETURNS:
+            str
+        """
+        with open(self.state['pem_file'], "r") as f:
+            private_key = f.read()
+        return jwt.encode(payload=payload, key=private_key, algorithm=header["alg"], headers=header)
+
+    def _proxy_jwt(self):
+        """
+        DESCRIPTION:
+            Generate JWT token and add the value in dictionary.
+
+        RETURNS:
+            str
+        """
+        jwt = self._sign_jwt(self._generate_payload(), self._generate_header())
+        self.state['jwt'] = jwt
+        return(jwt)

teradataml/common/aed_utils.py

@@ -1287,8 +1287,9 @@ class AedUtils:
         arg_name = ["group by"]
         # If option is passed, add prefix of the option to the groupby_expr,
         # else, add prefix as empty string.
-        arg_value = ["{} | {}".format(option, groupby_expr)] if option\
-            else ["{}| {}".format("", groupby_expr)]
+        if isinstance(groupby_expr, str):
+            arg_value = ["{} | {}".format(option, groupby_expr)] if option \
+               else ["{}| {}".format("", groupby_expr)]
         temp_table_name = UtilFuncs._generate_temp_table_name(prefix="groupby_", use_default_database=True, quote=False)
         output_table = [UtilFuncs._extract_table_name(temp_table_name)]
         output_schema = [UtilFuncs._extract_db_name(temp_table_name)]

teradataml/common/constants.py

@@ -65,6 +65,7 @@ class TeradataConstants(Enum):
     CONTAINER = 5
     TERADATA_TEXT_FILE = 6
     TERADATA_APPLY = 7
+    TERADATA_VOLATILE_TABLE = 8
     TABLE_COLUMN_LIMIT = 2048
     TERADATA_JOINS = ["inner", "left", "right", "full", "cross"]
     TERADATA_JOIN_OPERATORS = ['>=', '<=', '<>', '!=', '>', '<', '=']
@@ -463,18 +464,18 @@ class TableOperatorConstants(Enum):
                                 ON (select 1) PARTITION BY ANY
                                 SCRIPT_COMMAND('{}/bin/pip3 --version')
                                 returns('package VARCHAR(256)'))
-                             """.format(configure.indb_install_location)
+                             """
 
     # Script Query to get Python packages and corresponding versions.
     # Location of In-DB packages is indicated by configure.indb_install_location.
     partial_version_query = "SELECT distinct * FROM SCRIPT( ON (select 1) " \
-                            "PARTITION BY ANY SCRIPT_COMMAND('{}/bin/pip3 freeze | "\
-        .format(configure.indb_install_location)
-    PACKAGE_VERSION_QUERY = partial_version_query + "{0}awk -F ''=='' " \
+                            "PARTITION BY ANY SCRIPT_COMMAND('{0}/bin/pip3 freeze | "
+
+    PACKAGE_VERSION_QUERY = partial_version_query + "{1}awk -F ''=='' " \
                                                     "''{{print $1, $2}}''') " \
                                                     "delimiter(' ') " \
-                                                    "returns('package VARCHAR({1}), " \
-                                                    "version VARCHAR({1})'))"
+                                                    "returns('package VARCHAR({2}), " \
+                                                    "version VARCHAR({2})'))"
 
 class ValibConstants(Enum):
     # A dictionary that maps teradataml name of the exposed VALIB function name
@@ -1404,6 +1405,10 @@ class DriverEscapeFunctions(Enum):
     WRITE_TO_CSV = "{{fn teradata_write_csv({0})}}"
     FIELD_QUOTE = "{{fn teradata_field_quote({0})}}"
     FIELD_SEP = "{{fn teradata_field_sep({0})}}"
+    ERR_TBL_1 = "{{fn teradata_error_table_1_suffix({0})}}"
+    ERR_TBL_2 = "{{fn teradata_error_table_2_suffix({0})}}"
+    ERR_STAGING_DB = "{{fn teradata_error_table_database({0})}}"
+    ERR_TBL_MNG_FLAG = "{{fn teradata_manage_error_tables_{0}}}"
 
 
 class HTTPRequest(Enum):

teradataml/common/garbagecollector.py

@@ -64,8 +64,13 @@ class GarbageCollector():
         EXAMPLES:
             GarbageCollector._get_temp_dir_name()
         """
+        # Default location for .teradataml is user's home directory if configure.local_storage is not set.
         tempdir = expanduser("~")
         tempdir = os.path.join(tempdir, GarbageCollector.__garbagecollector_folder_name)
+
+        # set the .teradataml location to the location specified by the user.
+        if configure.local_storage:
+            tempdir = os.path.join(configure.local_storage, GarbageCollector.__garbagecollector_folder_name)
         return tempdir
 
     @staticmethod

teradataml/common/messagecodes.py

@@ -180,6 +180,7 @@ class ErrorInfoCodes(Enum):
     INVALID_LIST_LENGTH = 'TDML_2314'
 
     IMPORT_PYTHON_PACKAGE = 'TDML_2414'
+    PATH_NOT_FOUND = 'TDML_2415'
 
     # Script local run Error codes
     SCRIPT_LOCAL_RUN_ERROR = 'TDML_2410'
@@ -419,4 +420,5 @@ class MessageCodes(Enum):
                                         " feature columns."
     PARTITION_VALUES_NOT_MATCHING = "Values in training and test data partition columns should be same."
     PARTITION_IN_BOTH_FIT_AND_PREDICT = "Use \"partition_columns\" only if model is fitted with partition_column(s)."
-    INVALID_PARTITIONING_COLS = "Provided partition_column(s) '{}' is/are not present in parent of '{}' DataFrame(s)."
+    INVALID_PARTITIONING_COLS = "Provided partition_column(s) '{}' is/are not present in parent of '{}' DataFrame(s)."
+    PATH_NOT_FOUND = "Specified local path '{}' not found. Please check the path."

teradataml/common/messages.py

@@ -188,7 +188,8 @@ class Messages():
             [ErrorInfoCodes.PARTITIONING_COLS_IN_FEATURE_COLS, MessageCodes.PARTITIONING_COLS_IN_FEATURE_COLS],
             [ErrorInfoCodes.PARTITION_VALUES_NOT_MATCHING, MessageCodes.PARTITION_VALUES_NOT_MATCHING],
             [ErrorInfoCodes.PARTITION_IN_BOTH_FIT_AND_PREDICT, MessageCodes.PARTITION_IN_BOTH_FIT_AND_PREDICT],
-            [ErrorInfoCodes.INVALID_PARTITIONING_COLS, MessageCodes.INVALID_PARTITIONING_COLS]
+            [ErrorInfoCodes.INVALID_PARTITIONING_COLS, MessageCodes.INVALID_PARTITIONING_COLS],
+            [ErrorInfoCodes.PATH_NOT_FOUND, MessageCodes.PATH_NOT_FOUND]
     ]
 
     @staticmethod

teradataml/common/utils.py

@@ -300,6 +300,12 @@ class UtilFuncs():
             tabname = "{}_{}".format(tabname, prefix)
 
         tabname = "{}_{}".format(tabname, random_string)
+        
+        # ELE-6710 - Use database user associated with the current context for volatile tables.
+        if table_type == TeradataConstants.TERADATA_VOLATILE_TABLE:
+            from teradataml.context.context import _get_user
+            tabname = "\"{}\".\"{}\"".format(_get_user(), tabname)
+            return tabname
 
         if use_default_database and databasename is None:
             tabname = "\"{}\".\"{}\"".format(tdmlctx._get_context_temp_databasename(

teradataml/context/context.py

@@ -69,20 +69,24 @@ def _get_current_databasename():
     EXAMPLES:
         _get_current_databasename()
     """
-    if get_connection() is not None:
-        select_user_query = ""
-        try:
-            sqlbundle = SQLBundle()
-            select_user_query = sqlbundle._get_sql_query(SQLConstants.SQL_SELECT_DATABASE)
-            result = execute_sql(select_user_query)
-            return result.fetchall()[0][0]
-        except TeradataMlException:
-            raise
-        except Exception as err:
-            raise TeradataMlException(Messages.get_message(MessageCodes.TDMLDF_EXEC_SQL_FAILED, select_user_query),
-                                      MessageCodes.TDMLDF_EXEC_SQL_FAILED) from err
+    if configure._current_database_name:
+        return configure._current_database_name
     else:
-        return None
+        if get_connection() is not None:
+            select_user_query = ""
+            try:
+                sqlbundle = SQLBundle()
+                select_user_query = sqlbundle._get_sql_query(SQLConstants.SQL_SELECT_DATABASE)
+                result = execute_sql(select_user_query)
+                configure._current_database_name = result.fetchall()[0][0]
+                return configure._current_database_name
+            except TeradataMlException:
+                raise
+            except Exception as err:
+                raise TeradataMlException(Messages.get_message(MessageCodes.TDMLDF_EXEC_SQL_FAILED, select_user_query),
+                                          MessageCodes.TDMLDF_EXEC_SQL_FAILED) from err
+        else:
+            return None
 
 
 def _get_database_username():
@@ -101,20 +105,24 @@ def _get_database_username():
     EXAMPLES:
         _get_database_username()
     """
-    if get_connection() is not None:
-        select_query = ""
-        try:
-            sqlbundle = SQLBundle()
-            select_query = sqlbundle._get_sql_query(SQLConstants.SQL_SELECT_USER)
-            result = execute_sql(select_query)
-            return result.fetchall()[0][0]
-        except TeradataMlException:
-            raise
-        except Exception as err:
-            raise TeradataMlException(Messages.get_message(MessageCodes.TDMLDF_EXEC_SQL_FAILED, select_query),
-                                      MessageCodes.TDMLDF_EXEC_SQL_FAILED) from err
+    if configure._database_username:
+        return configure._database_username
     else:
-        return None
+        if get_connection() is not None:
+            select_query = ""
+            try:
+                sqlbundle = SQLBundle()
+                select_query = sqlbundle._get_sql_query(SQLConstants.SQL_SELECT_USER)
+                result = execute_sql(select_query)
+                configure._database_username = result.fetchall()[0][0]
+                return configure._database_username
+            except TeradataMlException:
+                raise
+            except Exception as err:
+                raise TeradataMlException(Messages.get_message(MessageCodes.TDMLDF_EXEC_SQL_FAILED, select_query),
+                                          MessageCodes.TDMLDF_EXEC_SQL_FAILED) from err
+        else:
+            return None
 
 
 def __cleanup_garbage_collection():
@@ -500,7 +508,11 @@ def create_context(host = None, username = None, password = None, tdsqlengine =
     __initalise_dag()
 
     # Set database version.
-    configure.database_version = _get_database_version()
+    _get_database_version()
+    # Set current database name.
+    _get_current_databasename()
+    # Set database user name.
+    _get_database_username()
 
     # Process Analytic functions.
     from teradataml.analytics import _process_analytic_functions
@@ -666,7 +678,7 @@ def remove_context():
     global python_packages_installed
     global td_user
 
-    # Intiate the garbage collection
+    # Initiate the garbage collection
     __cleanup_garbage_collection()
 
     if user_specified_connection is not True:
@@ -683,6 +695,9 @@ def remove_context():
     td_sqlalchemy_engine = None
     python_packages_installed = False
     td_user = None
+    configure._current_database_name = None
+    configure._database_username = None
+    configure.database_version = None
 
     # Closing Dag
     __close_dag()
@@ -717,6 +732,9 @@ def _get_context_temp_databasename(table_type=TeradataConstants.TERADATA_VIEW):
     if table_type == TeradataConstants.TERADATA_VIEW and \
             configure.temp_view_database is not None:
         return configure.temp_view_database
+    # ELE-6710 - Use database user associated with the current context for volatile tables.
+    if table_type == TeradataConstants.TERADATA_VOLATILE_TABLE:
+        return _get_user()
     return temporary_database_name
 
 
@@ -877,7 +895,9 @@ def _get_database_version():
     # RELEASE                        17.05a.00.147
 
     try:
-        return execute_sql(Query.VANTAGE_VERSION.value).fetchall()[0][0]
+        if configure.database_version is None:
+            configure.database_version = execute_sql(Query.VANTAGE_VERSION.value).fetchall()[0][0]
+        return configure.database_version
     except:
         return None
 

teradataml/data/advertising.csv

@@ -0,0 +1,201 @@
+TV,Radio,Newspaper,Sales
+230.1,37.8,69.2,22.1
+44.5,39.3,45.1,10.4
+17.2,45.9,69.3,12
+151.5,41.3,58.5,16.5
+180.8,10.8,58.4,17.9
+8.7,48.9,75,7.2
+57.5,32.8,23.5,11.8
+120.2,19.6,11.6,13.2
+8.6,2.1,1,4.8
+199.8,2.6,21.2,15.6
+66.1,5.8,24.2,12.6
+214.7,24,4,17.4
+23.8,35.1,65.9,9.2
+97.5,7.6,7.2,13.7
+204.1,32.9,46,19
+195.4,47.7,52.9,22.4
+67.8,36.6,114,12.5
+281.4,39.6,55.8,24.4
+69.2,20.5,18.3,11.3
+147.3,23.9,19.1,14.6
+218.4,27.7,53.4,18
+237.4,5.1,23.5,17.5
+13.2,15.9,49.6,5.6
+228.3,16.9,26.2,20.5
+62.3,12.6,18.3,9.7
+262.9,3.5,19.5,17
+142.9,29.3,12.6,15
+240.1,16.7,22.9,20.9
+248.8,27.1,22.9,18.9
+70.6,16,40.8,10.5
+292.9,28.3,43.2,21.4
+112.9,17.4,38.6,11.9
+97.2,1.5,30,13.2
+265.6,20,0.3,17.4
+95.7,1.4,7.4,11.9
+290.7,4.1,8.5,17.8
+266.9,43.8,5,25.4
+74.7,49.4,45.7,14.7
+43.1,26.7,35.1,10.1
+228,37.7,32,21.5
+202.5,22.3,31.6,16.6
+177,33.4,38.7,17.1
+293.6,27.7,1.8,20.7
+206.9,8.4,26.4,17.9
+25.1,25.7,43.3,8.5
+175.1,22.5,31.5,16.1
+89.7,9.9,35.7,10.6
+239.9,41.5,18.5,23.2
+227.2,15.8,49.9,19.8
+66.9,11.7,36.8,9.7
+199.8,3.1,34.6,16.4
+100.4,9.6,3.6,10.7
+216.4,41.7,39.6,22.6
+182.6,46.2,58.7,21.2
+262.7,28.8,15.9,20.2
+198.9,49.4,60,23.7
+7.3,28.1,41.4,5.5
+136.2,19.2,16.6,13.2
+210.8,49.6,37.7,23.8
+210.7,29.5,9.3,18.4
+53.5,2,21.4,8.1
+261.3,42.7,54.7,24.2
+239.3,15.5,27.3,20.7
+102.7,29.6,8.4,14
+131.1,42.8,28.9,16
+69,9.3,0.9,11.3
+31.5,24.6,2.2,11
+139.3,14.5,10.2,13.4
+237.4,27.5,11,18.9
+216.8,43.9,27.2,22.3
+199.1,30.6,38.7,18.3
+109.8,14.3,31.7,12.4
+26.8,33,19.3,8.8
+129.4,5.7,31.3,11
+213.4,24.6,13.1,17
+16.9,43.7,89.4,8.7
+27.5,1.6,20.7,6.9
+120.5,28.5,14.2,14.2
+5.4,29.9,9.4,5.3
+116,7.7,23.1,11
+76.4,26.7,22.3,11.8
+239.8,4.1,36.9,17.3
+75.3,20.3,32.5,11.3
+68.4,44.5,35.6,13.6
+213.5,43,33.8,21.7
+193.2,18.4,65.7,20.2
+76.3,27.5,16,12
+110.7,40.6,63.2,16
+88.3,25.5,73.4,12.9
+109.8,47.8,51.4,16.7
+134.3,4.9,9.3,14
+28.6,1.5,33,7.3
+217.7,33.5,59,19.4
+250.9,36.5,72.3,22.2
+107.4,14,10.9,11.5
+163.3,31.6,52.9,16.9
+197.6,3.5,5.9,16.7
+184.9,21,22,20.5
+289.7,42.3,51.2,25.4
+135.2,41.7,45.9,17.2
+222.4,4.3,49.8,16.7
+296.4,36.3,100.9,23.8
+280.2,10.1,21.4,19.8
+187.9,17.2,17.9,19.7
+238.2,34.3,5.3,20.7
+137.9,46.4,59,15
+25,11,29.7,7.2
+90.4,0.3,23.2,12
+13.1,0.4,25.6,5.3
+255.4,26.9,5.5,19.8
+225.8,8.2,56.5,18.4
+241.7,38,23.2,21.8
+175.7,15.4,2.4,17.1
+209.6,20.6,10.7,20.9
+78.2,46.8,34.5,14.6
+75.1,35,52.7,12.6
+139.2,14.3,25.6,12.2
+76.4,0.8,14.8,9.4
+125.7,36.9,79.2,15.9
+19.4,16,22.3,6.6
+141.3,26.8,46.2,15.5
+18.8,21.7,50.4,7
+224,2.4,15.6,16.6
+123.1,34.6,12.4,15.2
+229.5,32.3,74.2,19.7
+87.2,11.8,25.9,10.6
+7.8,38.9,50.6,6.6
+80.2,0,9.2,11.9
+220.3,49,3.2,24.7
+59.6,12,43.1,9.7
+0.7,39.6,8.7,1.6
+265.2,2.9,43,17.7
+8.4,27.2,2.1,5.7
+219.8,33.5,45.1,19.6
+36.9,38.6,65.6,10.8
+48.3,47,8.5,11.6
+25.6,39,9.3,9.5
+273.7,28.9,59.7,20.8
+43,25.9,20.5,9.6
+184.9,43.9,1.7,20.7
+73.4,17,12.9,10.9
+193.7,35.4,75.6,19.2
+220.5,33.2,37.9,20.1
+104.6,5.7,34.4,10.4
+96.2,14.8,38.9,12.3
+140.3,1.9,9,10.3
+240.1,7.3,8.7,18.2
+243.2,49,44.3,25.4
+38,40.3,11.9,10.9
+44.7,25.8,20.6,10.1
+280.7,13.9,37,16.1
+121,8.4,48.7,11.6
+197.6,23.3,14.2,16.6
+171.3,39.7,37.7,16
+187.8,21.1,9.5,20.6
+4.1,11.6,5.7,3.2
+93.9,43.5,50.5,15.3
+149.8,1.3,24.3,10.1
+11.7,36.9,45.2,7.3
+131.7,18.4,34.6,12.9
+172.5,18.1,30.7,16.4
+85.7,35.8,49.3,13.3
+188.4,18.1,25.6,19.9
+163.5,36.8,7.4,18
+117.2,14.7,5.4,11.9
+234.5,3.4,84.8,16.9
+17.9,37.6,21.6,8
+206.8,5.2,19.4,17.2
+215.4,23.6,57.6,17.1
+284.3,10.6,6.4,20
+50,11.6,18.4,8.4
+164.5,20.9,47.4,17.5
+19.6,20.1,17,7.6
+168.4,7.1,12.8,16.7
+222.4,3.4,13.1,16.5
+276.9,48.9,41.8,27
+248.4,30.2,20.3,20.2
+170.2,7.8,35.2,16.7
+276.7,2.3,23.7,16.8
+165.6,10,17.6,17.6
+156.6,2.6,8.3,15.5
+218.5,5.4,27.4,17.2
+56.2,5.7,29.7,8.7
+287.6,43,71.8,26.2
+253.8,21.3,30,17.6
+205,45.1,19.6,22.6
+139.5,2.1,26.6,10.3
+191.1,28.7,18.2,17.3
+286,13.9,3.7,20.9
+18.7,12.1,23.4,6.7
+39.5,41.1,5.8,10.8
+75.5,10.8,6,11.9
+17.2,4.1,31.6,5.9
+166.8,42,3.6,19.6
+149.7,35.6,6,17.3
+38.2,3.7,13.8,7.6
+94.2,4.9,8.1,14
+177,9.3,6.4,14.8
+283.6,42,66.2,25.5
+232.1,8.6,8.7,18.4