teradataml 20.0.0.3__py3-none-any.whl → 20.0.0.5__py3-none-any.whl

teradataml/common/messagecodes.py

@@ -125,6 +125,7 @@ class ErrorInfoCodes(Enum):
     SPECIFY_AT_LEAST_ONE_ARG = 'TDML_2037'
     CANNOT_USE_TOGETHER_WITH = 'TDML_2042'
     TABLE_DOES_NOT_EXIST = 'TDML_2046'
+    DEPENDENT_METHOD = 'TDML_2113'
 
     # Reserved for Generic Error Messages: 2121 - 2199
     RESERVED_KEYWORD = 'TDML_2121'
@@ -164,7 +165,7 @@ class ErrorInfoCodes(Enum):
     AED_SETOP_INPUT_TABLE_COLUMNS_COUNT_MISMATCH = 'TDML_2111'
     AED_SHOW_QUERY_MULTIPLE_OPTIONS = 'TDML_2112'
 
-    # Table Operator Error Codes starting from 2300 - Reserved till 2313
+    # Table Operator Error Codes starting from 2300 - Reserved till 2314
     INPUT_FILE_NOT_FOUND = 'TDML_2300'
     REMOVE_FILE_FAILED = 'TDML_2301'
     INSTALL_FILE_FAILED = 'TDML_2302'
@@ -175,6 +176,8 @@ class ErrorInfoCodes(Enum):
     NOT_ALLOWED_VALUES = 'TDML_2307'
     ARGUMENT_VALUE_SAME = 'TDML_2308'
     PYTHON_NOT_INSTALLED = 'TDML_2309'
+    PYTHON_VERSION_MISMATCH = 'TDML_2310'
+    PYTHON_VERSION_MISMATCH_OAF = 'TDML_2416'
     EMPTY_FILE = 'TDML_2311'
     ARG_NONE = 'TDML_2312'
     EITHER_FUNCTION_OR_ARGS = 'TDML_2313'
@@ -223,7 +226,7 @@ class ErrorInfoCodes(Enum):
     TARGET_COL_NOT_FOUND_FOR_EVALUATE = 'TDML_2541'
 
     # OpenAF Error codes starting from 2551 - Reserved till 2560.
-    AUTH_TOKEN_REQUIRED = 'TDML_2551'
+    SET_REQUIRED_PARAMS = 'TDML_2551'
 
 class MessageCodes(Enum):
     """
@@ -396,6 +399,10 @@ class MessageCodes(Enum):
 
     PYTHON_NOT_INSTALLED = "Python is not installed on Vantage. " \
                            "Please install Python interpreter and add-on packages on Vantage."
+    PYTHON_VERSION_MISMATCH = "Python version on Vantage is not same as that of local environment. " \
+                               "Use the same Python version '{}' or '{}.x' in local environment."
+    PYTHON_VERSION_MISMATCH_OAF = "Python version of Lake user environment '{}' is not same as that of local environment '{}'. " \
+                                  "Maintain similar version of Python between Lake user environment and local environment."
     IMPORT_PYTHON_PACKAGE = "Module '{}' not found. Install '{}' before running {}()."
     INT_ARGUMENT_COMPARISON = "Argument '{}' must be {} to argument '{}'"
     EXECUTION_FAILED = "Failed to {}. {}"
@@ -430,4 +437,8 @@ class MessageCodes(Enum):
     PATH_NOT_FOUND = "Specified local path '{}' not found. Please check the path."
     TARGET_COL_NOT_FOUND_FOR_EVALUATE = "Target column '{}' not found in the passed dataFrame. "\
                                         "evaluate() requires target column to be present in the dataFrame."
-    AUTH_TOKEN_REQUIRED = "Authentication token is required to run '{}'. Set the token using set_auth_token()."
+    SET_REQUIRED_PARAMS = "{} is required to run '{}'. Set it using {}()."
+    CONNECTION_PARAMS = "Required connection parameters are missing. Connection parameters should either be " \
+                        "explicitly passed to function or specified using a configuration file, or setting up " \
+                        "the environment variables."
+    DEPENDENT_METHOD = "Method(s) {} must be called before calling '{}'."

teradataml/common/messages.py

@@ -168,6 +168,8 @@ class Messages():
             [ErrorInfoCodes.UNSUPPORTED_FILE_EXTENSION, MessageCodes.UNSUPPORTED_FILE_EXTENSION],
             [ErrorInfoCodes.FILE_EMPTY, MessageCodes.FILE_EMPTY],
             [ErrorInfoCodes.PYTHON_NOT_INSTALLED, MessageCodes.PYTHON_NOT_INSTALLED],
+            [ErrorInfoCodes.PYTHON_VERSION_MISMATCH, MessageCodes.PYTHON_VERSION_MISMATCH],
+            [ErrorInfoCodes.PYTHON_VERSION_MISMATCH_OAF, MessageCodes.PYTHON_VERSION_MISMATCH_OAF],
             [ErrorInfoCodes.INT_ARGUMENT_COMPARISON, MessageCodes.INT_ARGUMENT_COMPARISON],
             [ErrorInfoCodes.EXECUTION_FAILED, MessageCodes.EXECUTION_FAILED],
             [ErrorInfoCodes.INVALID_COLUMN_DATATYPE, MessageCodes.INVALID_COLUMN_DATATYPE],
@@ -192,7 +194,9 @@ class Messages():
             [ErrorInfoCodes.INVALID_PARTITIONING_COLS, MessageCodes.INVALID_PARTITIONING_COLS],
             [ErrorInfoCodes.PATH_NOT_FOUND, MessageCodes.PATH_NOT_FOUND],
             [ErrorInfoCodes.TARGET_COL_NOT_FOUND_FOR_EVALUATE, MessageCodes.TARGET_COL_NOT_FOUND_FOR_EVALUATE],
-            [ErrorInfoCodes.AUTH_TOKEN_REQUIRED, MessageCodes.AUTH_TOKEN_REQUIRED],
+            [ErrorInfoCodes.SET_REQUIRED_PARAMS, MessageCodes.SET_REQUIRED_PARAMS],
+            [ErrorInfoCodes.MISSING_ARGS, MessageCodes.CONNECTION_PARAMS],
+            [ErrorInfoCodes.DEPENDENT_METHOD, MessageCodes.DEPENDENT_METHOD]
     ]
 
     @staticmethod
@@ -221,11 +225,11 @@ class Messages():
 
         """
         for msg in Messages.__messages:
-            if msg[1] == messagecode :
+            if msg[1] == messagecode:
                 message = "{}({}) {}".format(Messages.__standard_message, msg[0].value, msg[1].value)
                 if len(variables) != 0:
                     message = message.format(*variables)
-                if len(kwargs) != 0 :
+                if len(kwargs) != 0:
                     message = "{} {}".format(message, kwargs)
-
+                break
         return message

teradataml/common/sqlbundle.py

@@ -40,9 +40,9 @@ class SQLBundle:
                 [SQLConstants.SQL_BASE_QUERY, "SELECT * FROM {0}"],
                 [SQLConstants.SQL_SAMPLE_QUERY, " {0} SAMPLE {1}"],
                 [SQLConstants.SQL_SAMPLE_WITH_WHERE_QUERY, " {0} WHERE {1} SAMPLE {2}"],
-                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_FROM_QUERY_WITH_DATA, "CREATE MULTISET VOLATILE TABLE {0} AS ({1}) WITH DATA ON COMMIT PRESERVE ROWS"],
-                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_FROM_QUERY_WITHOUT_DATA, "CREATE MULTISET VOLATILE TABLE {0} AS ({1}) WITH NO DATA"],
-                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_USING_COLUMNS, "CREATE MULTISET VOLATILE TABLE {0}( {1} )"],
+                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_FROM_QUERY_WITH_DATA, "CREATE MULTISET VOLATILE TABLE {0} AS ({1}) WITH DATA NO PRIMARY INDEX ON COMMIT PRESERVE ROWS"],
+                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_FROM_QUERY_WITHOUT_DATA, "CREATE MULTISET VOLATILE TABLE {0} AS ({1}) WITH NO DATA NO PRIMARY INDEX"],
+                [SQLConstants.SQL_CREATE_VOLATILE_TABLE_USING_COLUMNS, "CREATE MULTISET VOLATILE TABLE {0}( {1} ) NO PRIMARY INDEX"],
                 [SQLConstants.SQL_CREATE_TABLE_FROM_QUERY_WITH_DATA, "CREATE MULTISET TABLE {0} AS ({1}) WITH DATA"],
                 [SQLConstants.SQL_HELP_COLUMNS, "help column {0}.*"],
                 [SQLConstants.SQL_DROP_TABLE, "DROP TABLE {0}"],
@@ -69,6 +69,8 @@ class SQLBundle:
                 [SQLConstants.SQL_CREATE_TABLE_USING_COLUMNS, "CREATE MULTISET TABLE {0}( {1} )"],
                 [SQLConstants.SQL_EXEC_STORED_PROCEDURE, "call {0}"],
                 [SQLConstants.SQL_SELECT_COLUMNNAMES_WITH_WHERE, "sel {0} from {1} where {2}"],
+                [SQLConstants.SQL_HELP_DATABASE, "HELP DATABASE {0}"],
+                [SQLConstants.SQL_HELP_DATALAKE, "HELP DATALAKE {0}"]
 
         ]
         self._add_sql_version()
@@ -257,14 +259,15 @@ class SQLBundle:
         return query.format(tablename, select_query)
 
     @staticmethod
-    def _build_drop_table(tablename):
+    def _build_drop_table(tablename, purge_clause=None):
         """
         Returns a drop table DDL statement for a table.
         Example:
             drop table mytab
 
         PARAMETERS:
-            tablename - The table to drop
+            tablename - The table to drop.
+            purge_clause - String representing purge clause.
 
         RETURNS:
             Returns a drop table DDL statement for the table.
@@ -273,12 +276,17 @@ class SQLBundle:
             None
 
         EXAMPLES:
-            dropstmt = SQLBundle._build_drop_table('mytab')
-
+            drop_stmt = SQLBundle._build_drop_table('my_tab')
+            drop_stmt = SQLBundle._build_drop_table("my_lake"."my_db"."my_tab",
+                                                    purge_clause='PURGE ALL')
+            drop_stmt = SQLBundle._build_drop_table("my_lake"."my_db"."my_tab",
+                                                    purge_clause='NO PURGE')
         """
         sqlbundle = SQLBundle()
-        dropstmt = sqlbundle._get_sql_query(SQLConstants.SQL_DROP_TABLE)
-        return dropstmt.format(tablename)
+        drop_stmt = sqlbundle._get_sql_query(SQLConstants.SQL_DROP_TABLE).format(tablename)
+        if purge_clause:
+            drop_stmt = "{} {}".format(drop_stmt, purge_clause)
+        return drop_stmt
 
     @staticmethod
     def _build_drop_view(viewname):
@@ -400,6 +408,28 @@ class SQLBundle:
         return sqlbundle._get_sql_query(SQLConstants.SQL_HELP_VOLATILE_TABLE)
 
     @staticmethod
+    def _build_help_datalake(datalake_name):
+        """
+        Builds a query to get help on datalake.
+
+        Example:
+            "HELP DATALAKE datalake_name;"
+
+        PARAMETERS:
+
+        RETURNS:
+            returns a HELP DATALAKE <datalake_name> command.
+
+        RAISES:
+            None
+
+        EXAMPLES:
+            query = SQLBundle._build_help_datalake(datalake_name)
+        """
+        sqlbundle = SQLBundle()
+        help_datalake_sql = sqlbundle._get_sql_query(SQLConstants.SQL_HELP_DATALAKE)
+        return help_datalake_sql.format(datalake_name)
+
     def _build_select_table_name(tab_name):
         """
         Builds a query to get table name from DBC.TABLESV
@@ -463,7 +493,7 @@ class SQLBundle:
                     # Extracting table name without '%' character
                     table_name_str = table_name.replace('%', '')
 
-                    # Adding condition to check if table name contains the string using POSITION function
+                    # Adding condition to check if table name contains the string using POSITION function.
                     # POSITION function returns the position index of the substring in the string if found,
                     # else returns 0
                     query = "{0}{1}{2}".format(query, sqlbundle._get_sql_query(SQLConstants.SQL_AND_TABLE_NAME_LIKE).format(table_name), \