teradataml 20.0.0.6__py3-none-any.whl → 20.0.0.7__py3-none-any.whl

teradataml/utils/utils.py

@@ -17,6 +17,8 @@ from teradataml.common.exceptions import TeradataMlException
 from teradataml.common.messages import Messages, MessageCodes
 from teradataml.common.constants import AsyncStatusColumns
 from teradataml.utils.validators import _Validators
+from teradatasql import OperationalError
+from teradataml.utils.dtypes import _ListOf
 
 # TODO: Add an option to set concurrency.
 _td_th_executor = ThreadPoolExecutor(max_workers=4)
@@ -24,7 +26,7 @@ _td_th_executor = ThreadPoolExecutor(max_workers=4)
 _async_run_id_info = {}
 
 
-def execute_sql(statement, parameters=None):
+def execute_sql(statement, parameters=None, ignore_errors=None):
     """
     DESCRIPTION:
         Executes the SQL statement by using provided parameters.
@@ -42,6 +44,17 @@ def execute_sql(statement, parameters=None):
             Specifies parameters to be used in case of parameterized query.
             Types: list of list, list of tuple
 
+        ignore_errors:
+            Optional Argument.
+            Specifies the error code(s) to ignore while running the statement.
+            Note:
+                * Error code(s) are Teradata Vantage error codes. Not teradataml
+                  error codes.
+                * All errors can be ignored by setting "ignore_errors" to 'all'.
+            Permitted Values:
+                * all - Ignore all the errors during execution.
+            Types: str, int or list of int
+
     RETURNS:
         Cursor object.
 
@@ -68,19 +81,45 @@ def execute_sql(statement, parameters=None):
         # Example 3: Run Help Column query on table.
         result_cursor = execute_sql('Help column table1.*;')
 
+        # Example 4: Create table 'Table_xyz' with one column of type integer.
+        #            Ignore the error if table already exists.
+        #            Note: Teradata error code while creating duplicate table is 3804.
+        result = execute_sql("Create table table_xyz (col_1 integer)", ignore_errors=[3804])
+
+        # Example 5: Drop table 'test_table' which does not exists.
+        #            Ignore all the errors if table not exists.
+        result = execute_sql("drop table test_table", ignore_errors='all')
+
     """
     # Validate argument types
     arg_info_matrix = []
     arg_info_matrix.append(["statement", statement, False, str, True])
     arg_info_matrix.append(["parameters", parameters, True, (tuple, list), False])
+    arg_info_matrix.append(["ignore_errors", ignore_errors, True, (int, _ListOf(int), str), True])
 
     _Validators._validate_function_arguments(arg_info_matrix)
 
+    # Validate permitted values, if its string.
+    if isinstance(ignore_errors, str):
+        _Validators._validate_permitted_values(ignore_errors, ['ALL'], "ignore_errors")
+
     from teradataml.context.context import get_context
     if get_context() is not None:
         tdsql_con = get_context().raw_connection().driver_connection
         cursor = tdsql_con.cursor()
-        return cursor.execute(statement, parameters)
+        # If user specifies error codes, then ignore those.
+        if not isinstance(ignore_errors, str):
+            return cursor.execute(statement, parameters, ignore_errors)
+
+        try:
+            return cursor.execute(statement, parameters)
+        except OperationalError as oe:
+            # When 'ignore_errors' is set to 'all', ignore all
+            # the errors during execution.
+            if ignore_errors == 'all':
+                pass
+            else:
+                raise oe
     else:
         raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_CONTEXT_CONNECTION),
                                   MessageCodes.INVALID_CONTEXT_CONNECTION)