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

teradataml/options/__init__.py

@@ -7,7 +7,6 @@ from teradataml.utils.internal_buffer import _InternalBuffer
 from teradataml.telemetry_utils.queryband import collect_queryband
 
 
-@argument_deprecation("future", ["auth_token", "ues_url"], False, None)
 @collect_queryband(queryband="StCnfgPrms")
 def set_config_params(**kwargs):
     """
@@ -20,21 +19,6 @@ def set_config_params(**kwargs):
             Optional Argument.
             Specifies keyword arguments. Accepts following keyword arguments:
 
-             auth_token:
-                Optional Parameter.
-                Specifies the authentication token to connect to VantageCloud Lake.
-                Notes:
-                     * Authentication token will expire after a specific time.
-                       One can get the new authentication token and set it again.
-                     * if "auth_token" is set through this function, then this function
-                       should always be used only after create_context.
-                Types: str
-
-            ues_url:
-                Optional Parameter.
-                Specifies the URL for User Environment Service in VantageCloud Lake.
-                Types: str
-
             certificate_file:
                 Optional Parameter.
                 Specifies the path of the certificate file, which is used in
@@ -95,9 +79,7 @@ def set_config_params(**kwargs):
     EXAMPLES:
         # Example 1: Set configuration params 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",
+        >>> set_config_params(certificate_file="cert.crt",
         ...                   default_varchar_size=512,
         ...                   val_install_location="VAL_USER",
         ...                   read_nos_function_mapping="read_nos_fm",
@@ -109,7 +91,6 @@ def set_config_params(**kwargs):
         # Example 2: Alternatively, set configuration parameters without using set_config_params() function.
         #            To do so, we will use configure module.
         >>> from teradataml import configure
-        >>> 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"
@@ -120,9 +101,12 @@ def set_config_params(**kwargs):
     """
     for option in kwargs:
         try:
-            if option == "auth_token":
-                from teradataml.scriptmgmt.lls_utils import _AuthToken
-                _InternalBuffer.add(auth_token=_AuthToken(token=kwargs[option]))
+            if option == "auth_token" or option == 'ues_url':
+                raise TeradataMlException(Messages.get_message(
+                    MessageCodes.FUNC_EXECUTION_FAILED, 'set_config_params',
+                    'Setting of parameter \'{}\' is prohibited from set_config_params(). '
+                    'Use set_auth_token() to set parameter.'.format(option)),
+                    MessageCodes.FUNC_EXECUTION_FAILED)
             else:
                 setattr(configure, option, kwargs[option])
         except AttributeError as e:

teradataml/options/configure.py

@@ -59,6 +59,7 @@ class _Configure(_ConfigureSuper):
     openml_user_env = _create_property('openml_user_env')
     local_storage = _create_property('local_storage')
     stored_procedure_install_location = _create_property('stored_procedure_install_location')
+    table_operator = _create_property('table_operator')
 
     def __init__(self, default_varchar_size=1024, column_casesensitive_handler = False,
                  vantage_version="vantage1.1", val_install_location=None,
@@ -67,7 +68,8 @@ class _Configure(_ConfigureSuper):
                  read_nos_function_mapping="read_nos", write_nos_function_mapping="write_nos",
                  cran_repositories=None, inline_plot=True, 
                  indb_install_location="/var/opt/teradata/languages/sles12sp3/Python/",
-                 openml_user_env=None, local_storage=None, stored_procedure_install_location="SYSLIB"):
+                 openml_user_env=None, local_storage=None, stored_procedure_install_location="SYSLIB",
+                 table_operator=None):
 
         """
         PARAMETERS:
@@ -181,6 +183,13 @@ class _Configure(_ConfigureSuper):
                     # when stored procedures are installed in 'SYSLIB'.
                     teradataml.options.configure.stored_procedure_install_location = "SYSLIB"
 
+            table_operator:
+                Specifies the name of the table operator.
+                Types: string
+                Example:
+                    # Set the table operator name to "Script"
+                    teradataml.options.configure.table_operator = "Script"
+
         """
         super().__init__()
         super().__setattr__('default_varchar_size', default_varchar_size)
@@ -199,6 +208,7 @@ class _Configure(_ConfigureSuper):
         super().__setattr__('openml_user_env', openml_user_env)
         super().__setattr__('local_storage', local_storage)
         super().__setattr__('stored_procedure_install_location', stored_procedure_install_location)
+        super().__setattr__('table_operator', table_operator)
 
         # internal configurations
         # These configurations are internal and should not be
@@ -228,6 +238,8 @@ class _Configure(_ConfigureSuper):
         # Internal parameter, that is used for specifying the URL to be used as
         # base URL in UES REST calls
         super().__setattr__('ues_url', None)
+        # base URL in Vector Store REST calls
+        super().__setattr__('_vector_store_base_url', None)
         # Internal parameter, that is used to specify the certificate file in a secured HTTP request.
         super().__setattr__('certificate_file', False)
         # Internal parameter, that is used for specify the maximum size of the file
@@ -325,7 +337,7 @@ class _Configure(_ConfigureSuper):
                             Messages.get_message(MessageCodes.PATH_NOT_FOUND).format(value),
                             MessageCodes.PATH_NOT_FOUND)
 
-            elif name in {'ues_url', '_oauth_end_point', '_oauth_client_id'}:
+            elif name in {'ues_url', '_oauth_end_point', '_oauth_client_id', '_vector_store_base_url'}:
 
                 if not isinstance(value, str):
                     raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'str'))
@@ -333,7 +345,7 @@ class _Configure(_ConfigureSuper):
                 if len(value) == 0:
                     raise ValueError(Messages.get_message(MessageCodes.ARG_EMPTY, name))
 
-                if name == 'ues_url':
+                if name in ['ues_url', '_vector_store_base_url']:
                     value = value[: -1] if value.endswith("/") else value
 
             elif name in ['temp_table_database', 'temp_view_database',
@@ -362,6 +374,20 @@ class _Configure(_ConfigureSuper):
                 if not isinstance(value, UserEnv) and not isinstance(value, type(None)):
                     raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'UserEnv or None'))
 
+            elif name == 'table_operator':
+                if not isinstance(value, str) and not isinstance(value, type(None)):
+                    raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'str or None'))
+
+                if value is not None:
+                    valid_names = ['script', 'apply']
+                    value = value.lower()
+                    if value not in valid_names:
+                        raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_ARG_VALUE,
+                                                                       value,
+                                                                       name,
+                                                                       "a value in {}".format(valid_names)),
+                                                  MessageCodes.INVALID_ARG_VALUE)
+
             super().__setattr__(name, value)
         else:
             raise AttributeError("'{}' object has no attribute '{}'".format(self.__class__.__name__, name))

teradataml/scriptmgmt/UserEnv.py

@@ -205,7 +205,7 @@ def _process_ues_response(api_name, response, success_status_code=None):
 def _get_auth_token():
     """
     DESCRIPTION:
-        Internal function to get Authentication token for all UES REST calls
+        Internal function to get Authentication token for all CCP enabled REST calls
 
     PARAMETERS:
         None
@@ -238,8 +238,8 @@ def _get_auth_token():
 
             # Store the jwt token in internal class attribute.
             _InternalBuffer.add(auth_token=_AuthToken(token=token_data["access_token"]))
-
-    return {"Authorization": "Bearer {}".format(_InternalBuffer.get("auth_token").value)}
+    if _InternalBuffer.get("auth_token"):
+        return {"Authorization": "Bearer {}".format(_InternalBuffer.get("auth_token").value)}
 
 
 class UserEnv:

teradataml/scriptmgmt/lls_utils.py

@@ -23,6 +23,7 @@ from json.decoder import JSONDecodeError
 from teradataml import configure
 from teradataml.context.context import _get_user, get_connection
 from teradataml.common.constants import HTTPRequest, AsyncStatusColumns
+from teradataml.common.deprecations import argument_deprecation
 from teradataml.common.exceptions import TeradataMlException
 from teradataml.common.messages import Messages
 from teradataml.common.messagecodes import MessageCodes
@@ -40,7 +41,6 @@ from urllib.parse import parse_qs, urlparse
 from teradataml.utils.utils import _async_run_id_info
 from teradataml.telemetry_utils.queryband import collect_queryband
 
-
 @collect_queryband(queryband="LstBsEnv")
 def list_base_envs():
     """
@@ -437,11 +437,18 @@ def __create_envs(template):
                 if libs or libs_file_path:
                     print("Installing libraries in environment '{}'...".format(env_name))
                     try:
-                        env_handle.install_lib(libs, libs_file_path)
-                        print("Libraries installation in environment '{}' - Completed.".format(env_name))
+                        status = env_handle.install_lib(libs, libs_file_path)
+                        if status['Stage'][1] == 'Errored':
+                            err_message = status['Additional Details'][1].replace("Error with package maintenance -> ", "\n")
+                            raise Exception(err_message)
+                        else:
+                            print("Libraries installation in environment '{}' - Completed.".format(env_name))
                     except Exception as lib_installation_failure:
-                        print("Failed to process library installation request for environment: '{}'".format(env_name))
-                        print(str(lib_installation_failure))
+                        error_code = MessageCodes.FUNC_EXECUTION_FAILED
+                        error_msg = Messages.get_message(error_code,
+                                                         "'install_lib' request for enviornment: '{}'".format(env_name), 
+                                                         '\n'+str(lib_installation_failure))
+                        print(error_msg)
                         errored = errored or True
                         pass
 
@@ -741,9 +748,11 @@ def create_env(env_name=None, base_env=None, desc=None, template=None, conda_env
         # Validate arguments
         _Validators._validate_function_arguments(__arg_info_matrix, skip_empty_check=False)
 
-        # Get the latest python base env in OpenAF, if base_env is not provided.
+        # Get the latest python base env in OpenAF, if base_env is not provided,
+        # Or if base_env is provided and not in the list of base envs.
         # Note: By default python base env is obtained.
-        if not base_env:
+        if not base_env or \
+        (base_env and  base_env.lower() not in list_base_envs()['base_name'].str.lower().to_list()):
             base_env = __get_default_base_env()
         if not desc:
             desc = "This env '{}' is created with base env '{}'.".format(env_name, base_env)
@@ -1550,7 +1559,8 @@ def get_user_env():
 
 
 @collect_queryband(queryband="StAthTkn")
-def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwargs):
+@argument_deprecation("20.00.00.04", "ues_url", False, "base_url")
+def set_auth_token(base_url=None, client_id=None, pat_token=None, pem_file=None, **kwargs):
     """
     DESCRIPTION:
         Function to set the Authentication token to connect to User Environment Service
@@ -1563,11 +1573,17 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
             Refresh token still works but only for OAuth authentication.
 
     PARAMETERS:
+
         ues_url:
             Required Argument.
             Specifies the URL for User Environment Service in VantageCloud Lake.
             Types: str
 
+        base_url:
+            Required Argument.
+            Specifies the CCP endpoint URL.
+            Types: str
+
         client_id:
             Optional Argument.
             Specifies the id of the application that requests the access token from
@@ -1601,6 +1617,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
                 Default Value: 31536000
                 Types: int
 
+            auth_token:
+                Optional Parameter.
+                Specifies the authentication token to connect to VantageCloud Lake.
+                Notes:
+                     * if "auth_token" is set through this function, then this function
+                       should always be used only after create_context.
+                     * use this option only if user has got JWT token and wants to set the same
+                       instead of generating it again from this function.
+                Types: str
+
     RETURNS:
         True, if the operation is successful.
 
@@ -1611,16 +1637,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
 
         # Example 1: Set the Authentication token using default client_id.
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "))
+        >>> set_auth_token(base_url=getpass.getpass("ues_url : "))
 
         # Example 2: Set the Authentication token by specifying the client_id.
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                client_id=getpass.getpass("client_id : "))
 
         # Example 3: Set the Authentication token by specifying the "pem_file" and "pat_token"
         #            without specifying "username".
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                pat_token=getpass.getpass("pat_token : "),
         ...                pem_file=getpass.getpass("pem_file : "))
         True
@@ -1628,7 +1654,7 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         # Example 4: Set the Authentication token by specifying the "pem_file" and "pat_token"
         #            and "username".
         >>> import getpass
-        >>> set_auth_token(ues_url=getpass.getpass("ues_url : "),
+        >>> set_auth_token(base_url=getpass.getpass("base_url : "),
         ...                pat_token=getpass.getpass("pat_token : "),
         ...                pem_file=getpass.getpass("pem_file : "))
         ...                username = "alice")
@@ -1640,8 +1666,12 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_CONTEXT_CONNECTION), 
                                   MessageCodes.INVALID_CONTEXT_CONNECTION)
 
+    # Getting the ues_url.
+    ues_url = kwargs.get("ues_url", None)
+
     __arg_info_matrix = []
-    __arg_info_matrix.append(["ues_url", ues_url, False, (str), True])
+    __arg_info_matrix.append(["base_url", base_url, True, (str), True])
+    __arg_info_matrix.append(["ues_url", ues_url, True, (str), True])
     __arg_info_matrix.append(["client_id", client_id, True, (str), True])
     __arg_info_matrix.append(["pat_token", pat_token, True, (str), True])
     __arg_info_matrix.append(["pem_file", pem_file, True, (str), True])
@@ -1649,12 +1679,38 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
     username = kwargs.get("username", None)
     __arg_info_matrix.append((["username", username, True, (str), True]))
 
+    auth_token = kwargs.get("auth_token")
+    __arg_info_matrix.append((["auth_token", auth_token, True, (str), True]))
+
     expiration_time = kwargs.get("expiration_time", 31536000)
     __arg_info_matrix.append((["expiration_time", expiration_time, True, (int), True]))
 
     # Validate arguments.
     _Validators._validate_function_arguments(__arg_info_matrix)
 
+    # base_url should not end with 'open-analytics' or 'data-insights'
+    if base_url:
+        if base_url.endswith('open-analytics') or base_url.endswith('data-insights'):
+            message = Messages.get_message(MessageCodes.ARG_NONE,
+                                           "base_url", "ending with 'data-insights' or 'open-analytics", None)
+            raise TeradataMlException(message, MessageCodes.ARG_NONE)
+
+        # Set the vector_store_base_url. This should only be done if base_url is set.
+        # In case ues_url is set, vector_store_base_url should not be set.
+        configure._vector_store_base_url = f'{base_url}/data-insights'
+
+    # If ues_url is provided, then use it as base_url.
+    base_url = kwargs.get("ues_url", base_url)
+
+    # Set the OpenAF url.
+    # If ues_url is present use that otherwise generate it from base_url.
+    configure.ues_url = ues_url if ues_url else f'{base_url}/open-analytics'
+
+    # If user pass Auth token, set it.
+    if auth_token:
+        _InternalBuffer.add(auth_token=_AuthToken(token=auth_token))
+        return True
+
     if client_id and any([pat_token, pem_file]):
         message = Messages.get_message(MessageCodes.EITHER_THIS_OR_THAT_ARGUMENT,
                                        "client_id", "pat_token' and 'pem_file")
@@ -1670,16 +1726,16 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
     if pem_file is not None:
         _Validators._validate_file_exists(pem_file)
 
-    # Extract the base URL from "ues_url".
-    url_parser = urlparse(ues_url)
-    base_url = "{}://{}".format(url_parser.scheme, url_parser.netloc)
+    # Extract the base URL.
+    url_parser = urlparse(base_url)
+    parsed_base_url = "{}://{}".format(url_parser.scheme, url_parser.netloc)
     netloc = url_parser.netloc.split('.')[0]
 
     # Check if the authentication is PAT based or OAuth.
     if all(arg is None for arg in [pat_token, pem_file]):
         configure._oauth = True
         client_id = "{}-oaf-device".format(netloc) if client_id is None else client_id
-        da_wf = _DAWorkflow(base_url, client_id)
+        da_wf = _DAWorkflow(parsed_base_url, client_id)
         token_data = da_wf._get_token_data()
 
         # Set Open AF parameters.
@@ -1702,7 +1758,7 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
 
         # Construct a dictionary to be passed to _AuthWorkflow().
         state_dict = {}
-        state_dict["base_url"] = base_url
+        state_dict["base_url"] = parsed_base_url
         state_dict["org_id"] = org_id
         state_dict["pat_token"] = pat_token
         state_dict["pem_file"] = pem_file
@@ -1714,7 +1770,4 @@ def set_auth_token(ues_url, client_id=None, pat_token=None, pem_file=None, **kwa
         # Store the jwt token in internal class attribute.
         _InternalBuffer.add(auth_token=_AuthToken(token=token_data))
 
-    # Set Open AF parameters.
-    configure.ues_url = ues_url
-
     return True

teradataml/store/__init__.py

@@ -0,0 +1,13 @@
+"""
+Copyright (c) 2024 by Teradata Corporation. All rights reserved.
+TERADATA CORPORATION CONFIDENTIAL AND TRADE SECRET
+
+Primary Owner: pradeep.garre@teradata.com
+Secondary Owner: aanchal.kavedia@teradata.com
+
+This file imports components from Feature Store and Vector Store.
+"""
+
+from teradataml.store.feature_store.feature_store import FeatureStore
+from teradataml.store.feature_store.models import *
+from teradataml.store.vector_store import *