MindsDB 1.3.1__py3-none-any.whl → 24.12.4.0__py3-none-any.whl

mindsdb/integrations/handlers/salesforce_handler/connection_args.py

@@ -0,0 +1,39 @@
+from collections import OrderedDict
+
+from mindsdb.integrations.libs.const import HANDLER_CONNECTION_ARG_TYPE as ARG_TYPE
+
+
+connection_args = OrderedDict(
+    username={
+        'type': ARG_TYPE.STR,
+        'description': 'The username for the Salesforce account.',
+        'required': True,
+        'label': 'Username'
+    },
+    password={
+        'type': ARG_TYPE.PWD,
+        'description': 'The password for the Salesforce account.',
+        'secret': True,
+        'required': True,
+        'label': 'Password'
+    },
+    client_id={
+        'type': ARG_TYPE.STR,
+        'description': 'The client ID (consumer key) from a connected app in Salesforce.',
+        'required': True,
+        'label': 'Client ID (Consumer Key)'
+    },
+    client_secret={
+        'type': ARG_TYPE.STR,
+        'description': 'The client secret (consumer secret) from a connected app in Salesforce.',
+        'required': True,
+        'label': 'Client Secret (Consumer Secret)'
+    }
+)
+
+connection_args_example = OrderedDict(
+    username='demo@example.com',
+    password='demo_password',
+    client_id='3MVG9lKcPoNINVBIPJjdw1J9LLM82HnZz9Yh7ZJnY',
+    client_secret='5A52C1A1E21DF9012IODC9ISNXXAADDA9'
+)

mindsdb/integrations/handlers/salesforce_handler/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="2500" height="1750" viewBox="0.5 0.5 999 699.242"><path fill="#00A1E0" d="M416.224 76.763c32.219-33.57 77.074-54.391 126.682-54.391 65.946 0 123.48 36.772 154.12 91.361 26.626-11.896 56.098-18.514 87.106-18.514 118.94 0 215.368 97.268 215.368 217.247 0 119.993-96.428 217.261-215.368 217.261a213.735 213.735 0 0 1-42.422-4.227c-26.981 48.128-78.397 80.646-137.412 80.646-24.705 0-48.072-5.706-68.877-15.853-27.352 64.337-91.077 109.448-165.348 109.448-77.344 0-143.261-48.939-168.563-117.574-11.057 2.348-22.513 3.572-34.268 3.572C75.155 585.74.5 510.317.5 417.262c0-62.359 33.542-116.807 83.378-145.937-10.26-23.608-15.967-49.665-15.967-77.06C67.911 87.25 154.79.5 261.948.5c62.914 0 118.827 29.913 154.276 76.263"/><path fill="#FFF" d="M145.196 363.11c-.626 1.637.228 1.979.427 2.263 1.878 1.366 3.786 2.349 5.707 3.444 10.189 5.407 19.81 6.986 29.871 6.986 20.492 0 33.214-10.9 33.214-28.447v-.341c0-16.224-14.358-22.115-27.835-26.37l-1.75-.569c-10.161-3.302-18.927-6.147-18.927-12.836v-.355c0-5.721 5.123-9.934 13.064-9.934 8.823 0 19.297 2.932 26.042 6.66 0 0 1.978 1.281 2.704-.64.398-1.025 3.814-10.218 4.17-11.214.384-1.082-.299-1.879-.996-2.306-7.699-4.682-18.344-7.884-29.358-7.884l-2.049.014c-18.756 0-31.848 11.328-31.848 27.565v.342c0 17.119 14.444 22.669 27.978 26.54l2.177.669c9.862 3.031 18.358 5.635 18.358 12.58v.342c0 6.347-5.521 11.071-14.43 11.071-3.458 0-14.487-.071-26.398-7.6-1.438-.84-2.277-1.451-3.387-2.12-.583-.37-2.049-1.011-2.689.925l-4.045 11.215zM445.194 363.11c-.626 1.637.228 1.979.427 2.263 1.878 1.366 3.786 2.349 5.706 3.444 10.189 5.407 19.811 6.986 29.871 6.986 20.492 0 33.215-10.9 33.215-28.447v-.341c0-16.224-14.359-22.115-27.836-26.37l-1.75-.569c-10.161-3.302-18.928-6.147-18.928-12.836v-.355c0-5.721 5.123-9.934 13.064-9.934 8.823 0 19.297 2.932 26.043 6.66 0 0 1.978 1.281 2.703-.64.398-1.025 3.814-10.218 4.17-11.214.385-1.082-.299-1.879-.996-2.306-7.699-4.682-18.344-7.884-29.358-7.884l-2.05.014c-18.756 0-31.848 11.328-31.848 27.565v.342c0 17.119 14.444 22.669 27.978 26.54l2.177.669c9.862 3.031 18.373 5.635 18.373 12.58v.342c0 6.347-5.536 11.071-14.445 11.071-3.457 0-14.486-.071-26.397-7.6-1.438-.84-2.291-1.423-3.372-2.12-.371-.242-2.107-.911-2.705.925l-4.042 11.215zM649.995 328.74c0 9.919-1.85 17.731-5.493 23.253-3.601 5.465-9.051 8.126-16.649 8.126-7.613 0-13.035-2.647-16.579-8.126-3.587-5.507-5.407-13.334-5.407-23.253 0-9.904 1.82-17.703 5.407-23.168 3.544-5.407 8.966-8.04 16.579-8.04 7.599 0 13.049 2.633 16.664 8.04 3.629 5.464 5.478 13.263 5.478 23.168m17.106-18.386c-1.68-5.679-4.298-10.688-7.784-14.857-3.487-4.184-7.898-7.542-13.136-9.99-5.223-2.433-11.398-3.671-18.328-3.671-6.945 0-13.121 1.238-18.344 3.671-5.237 2.448-9.648 5.807-13.149 9.99-3.472 4.184-6.091 9.193-7.784 14.857-1.665 5.649-2.505 11.825-2.505 18.386s.84 12.751 2.505 18.386c1.693 5.664 4.298 10.674 7.799 14.857 3.486 4.184 7.912 7.528 13.135 9.904 5.236 2.377 11.398 3.586 18.344 3.586 6.93 0 13.092-1.209 18.328-3.586 5.223-2.376 9.648-5.721 13.136-9.904 3.486-4.17 6.104-9.179 7.784-14.857 1.68-5.649 2.519-11.84 2.519-18.386s-.841-12.737-2.52-18.386M807.568 357.47c-.569-1.665-2.177-1.039-2.177-1.039-2.49.954-5.138 1.836-7.955 2.277-2.861.44-6.006.669-9.379.669-8.281 0-14.856-2.462-19.566-7.329-4.725-4.867-7.372-12.736-7.344-23.381.029-9.691 2.362-16.978 6.561-22.527 4.17-5.521 10.517-8.354 18.984-8.354 7.059 0 12.438.811 18.072 2.59 0 0 1.352.583 1.992-1.181 1.494-4.156 2.604-7.13 4.198-11.698.456-1.295-.654-1.85-1.053-2.007-2.22-.868-7.457-2.276-11.413-2.874-3.7-.569-8.026-.868-12.836-.868-7.188 0-13.591 1.224-19.069 3.672-5.465 2.433-10.104 5.791-13.775 9.976-3.672 4.184-6.461 9.192-8.325 14.856-1.85 5.649-2.789 11.854-2.789 18.415 0 14.188 3.828 25.657 11.385 34.054 7.57 8.425 18.941 12.708 33.77 12.708 8.766 0 17.76-1.778 24.221-4.326 0 0 1.238-.598.697-2.034l-4.199-11.599zM837.497 319.238c.811-5.507 2.334-10.09 4.682-13.661 3.544-5.422 8.951-8.396 16.551-8.396s12.623 2.988 16.223 8.396c2.391 3.571 3.43 8.354 3.843 13.661h-41.299zm57.592-12.111c-1.451-5.479-5.052-11.015-7.414-13.548-3.729-4.013-7.371-6.816-10.986-8.382-4.725-2.021-10.389-3.358-16.593-3.358-7.229 0-13.79 1.21-19.112 3.714-5.336 2.505-9.818 5.921-13.334 10.176-3.516 4.24-6.162 9.292-7.842 15.027-1.693 5.707-2.547 11.926-2.547 18.485 0 6.675.883 12.894 2.633 18.486 1.765 5.636 4.582 10.602 8.396 14.714 3.799 4.142 8.695 7.387 14.558 9.648 5.821 2.249 12.894 3.416 21.019 3.401 16.722-.057 25.53-3.785 29.159-5.792.641-.355 1.253-.981.483-2.774l-3.785-10.603c-.568-1.579-2.177-.996-2.177-.996-4.142 1.537-10.032 4.298-23.766 4.27-8.979-.014-15.64-2.661-19.81-6.803-4.283-4.24-6.375-10.474-6.745-19.268l57.905.057s1.522-.028 1.68-1.509c.057-.624 1.993-11.895-1.722-24.945M373.762 319.238c.825-5.507 2.334-10.09 4.682-13.661 3.543-5.422 8.951-8.396 16.55-8.396s12.623 2.988 16.237 8.396c2.376 3.571 3.415 8.354 3.828 13.661h-41.297zm57.577-12.111c-1.451-5.479-5.037-11.015-7.399-13.548-3.729-4.013-7.372-6.816-10.986-8.382-4.725-2.021-10.388-3.358-16.593-3.358-7.215 0-13.79 1.21-19.112 3.714-5.336 2.505-9.819 5.921-13.334 10.176-3.515 4.24-6.162 9.292-7.841 15.027-1.679 5.707-2.547 11.926-2.547 18.485 0 6.675.882 12.894 2.633 18.486 1.765 5.636 4.583 10.602 8.396 14.714 3.8 4.142 8.695 7.387 14.558 9.648 5.821 2.249 12.893 3.416 21.019 3.401 16.721-.057 25.53-3.785 29.159-5.792.641-.355 1.252-.981.484-2.774l-3.771-10.603c-.584-1.579-2.191-.996-2.191-.996-4.141 1.537-10.019 4.298-23.78 4.27-8.965-.014-15.625-2.661-19.795-6.803-4.284-4.24-6.375-10.474-6.746-19.268l57.905.057s1.522-.028 1.679-1.509c.055-.624 1.99-11.895-1.738-24.945M248.601 357.153c-2.263-1.808-2.576-2.263-3.344-3.43-1.139-1.779-1.722-4.312-1.722-7.528 0-5.095 1.679-8.752 5.166-11.214-.042.015 4.981-4.34 16.792-4.184 8.296.114 15.71 1.338 15.71 1.338v26.327h.014s-7.357 1.579-15.639 2.077c-11.783.712-17.02-3.4-16.977-3.386m23.039-40.686c-2.348-.171-5.394-.271-9.037-.271-4.966 0-9.762.626-14.259 1.836-4.525 1.209-8.595 3.103-12.096 5.606a27.927 27.927 0 0 0-8.396 9.549c-2.049 3.814-3.088 8.311-3.088 13.349 0 5.123.882 9.577 2.647 13.221 1.765 3.657 4.312 6.702 7.556 9.051 3.216 2.348 7.187 4.069 11.797 5.108 4.54 1.039 9.691 1.565 15.327 1.565 5.934 0 11.854-.483 17.589-1.466 5.678-.968 12.651-2.377 14.586-2.817a146.25 146.25 0 0 0 4.056-1.039c1.438-.355 1.324-1.893 1.324-1.893l-.029-52.952c0-11.613-3.102-20.223-9.207-25.559-6.077-5.322-15.028-8.013-26.597-8.013-4.341 0-11.328.599-15.512 1.438 0 0-12.651 2.448-17.86 6.518 0 0-1.138.712-.512 2.306l4.099 11.015c.512 1.423 1.893.939 1.893.939s.441-.171.954-.47c11.143-6.062 25.231-5.877 25.231-5.877 6.262 0 11.072 1.252 14.316 3.742 3.159 2.419 4.767 6.076 4.767 13.789v2.448c-4.981-.711-9.549-1.123-9.549-1.123M738.669 286.631c.44-1.31-.484-1.936-.869-2.078-.981-.384-5.905-1.423-9.705-1.665-7.271-.441-11.312.783-14.928 2.405-3.586 1.622-7.57 4.24-9.791 7.215v-7.044c0-.982-.697-1.765-1.665-1.765h-14.843c-.967 0-1.664.782-1.664 1.765v86.366c0 .968.797 1.765 1.764 1.765h15.213a1.76 1.76 0 0 0 1.75-1.765v-43.147c0-5.792.641-11.569 1.922-15.198 1.252-3.587 2.96-6.461 5.066-8.525 2.12-2.049 4.525-3.486 7.158-4.297 2.689-.826 5.663-1.096 7.77-1.096 3.031 0 6.361.782 6.361.782 1.109.128 1.736-.555 2.105-1.565.997-2.647 3.815-10.574 4.356-12.153"/><path fill="#FFF" d="M595.874 246.603c-1.85-.569-3.529-.954-5.721-1.366-2.221-.398-4.867-.598-7.869-.598-10.475 0-18.729 2.96-24.52 8.794-5.764 5.807-9.678 14.644-11.642 26.271l-.712 3.913h-13.148s-1.594-.057-1.936 1.68l-2.148 12.053c-.157 1.139.342 1.864 1.878 1.864h12.794l-12.979 72.463c-1.011 5.835-2.178 10.631-3.473 14.273-1.267 3.587-2.504 6.276-4.041 8.24-1.48 1.879-2.875 3.273-5.295 4.084-1.992.669-4.297.982-6.816.982-1.395 0-3.258-.229-4.639-.513-1.366-.271-2.092-.569-3.131-1.011 0 0-1.494-.568-2.092.926-.47 1.238-3.885 10.615-4.298 11.769-.398 1.152.171 2.049.896 2.319 1.708.598 2.974.996 5.294 1.551 3.217.755 5.934.797 8.481.797 5.322 0 10.189-.754 14.217-2.205 4.042-1.466 7.57-4.014 10.701-7.457 3.373-3.729 5.493-7.628 7.515-12.964 2.006-5.266 3.729-11.812 5.094-19.439l13.05-73.815h19.069s1.607.057 1.936-1.693l2.162-12.039c.143-1.152-.341-1.864-1.893-1.864h-18.514c.1-.412.939-6.931 3.06-13.063.911-2.604 2.618-4.725 4.056-6.177 1.424-1.423 3.06-2.433 4.854-3.017 1.835-.598 3.928-.882 6.219-.882 1.736 0 3.457.199 4.752.469 1.793.385 2.49.584 2.961.727 1.893.569 2.148.014 2.519-.896l4.426-12.153c.455-1.312-.669-1.867-1.067-2.023M337.194 371.834c0 .968-.697 1.751-1.665 1.751h-15.355c-.968 0-1.651-.783-1.651-1.751v-123.58c0-.967.683-1.75 1.651-1.75h15.355c.968 0 1.665.783 1.665 1.75v123.58z"/></svg>

mindsdb/integrations/handlers/salesforce_handler/requirements.txt

@@ -0,0 +1 @@
+salesforce_api

mindsdb/integrations/handlers/salesforce_handler/salesforce_handler.py

@@ -0,0 +1,180 @@
+from typing import Any, Dict, Text
+
+import pandas as pd
+import salesforce_api
+from salesforce_api.exceptions import AuthenticationError, RestRequestCouldNotBeUnderstoodError
+
+from mindsdb.integrations.libs.api_handler import APIHandler
+from mindsdb.integrations.libs.response import (
+    HandlerResponse as Response,
+    HandlerStatusResponse as StatusResponse,
+    RESPONSE_TYPE
+)
+from mindsdb.integrations.handlers.salesforce_handler.salesforce_tables import create_table_class
+from mindsdb.utilities import log
+
+
+logger = log.getLogger(__name__)
+
+
+class SalesforceHandler(APIHandler):
+    """
+    This handler handles the connection and execution of SQL statements on Salesforce.
+    """
+
+    name = 'salesforce'
+
+    def __init__(self, name: Text, connection_data: Dict, **kwargs: Any) -> None:
+        """
+        Initializes the handler.
+
+        Args:
+            name (Text): The name of the handler instance.
+            connection_data (Dict): The connection data required to connect to the Salesforce API.
+            kwargs: Arbitrary keyword arguments.
+        """
+        super().__init__(name)
+        self.connection_data = connection_data
+        self.kwargs = kwargs
+
+        self.connection = None
+        self.is_connected = False
+
+        # Register Salesforce tables.
+        self.resource_names = {
+            'Account',
+            'Contact',
+            'Opportunity',
+            'Lead',
+            'Task',
+            'Event',
+            'User',
+            'Product2',
+            'Pricebook2',
+            'PricebookEntry',
+            'Order',
+            'OrderItem',
+            'Case',
+            'Campaign',
+            'CampaignMember',
+            'Contract',
+            'Asset'
+        }
+
+        for resource_name in self.resource_names:
+            table_class = create_table_class(resource_name, resource_name)
+            self._register_table(resource_name, table_class(self))
+
+    def connect(self) -> salesforce_api.client.Client:
+        """
+        Establishes a connection to the Salesforce API.
+
+        Raises:
+            ValueError: If the required connection parameters are not provided.
+            AuthenticationError: If an authentication error occurs while connecting to the Salesforce API.
+
+        Returns:
+            salesforce_api.client.Client: A connection object to the Salesforce API.
+        """
+        if self.is_connected is True:
+            return self.connection
+
+        # Mandatory connection parameters.
+        if not all(key in self.connection_data for key in ['username', 'password', 'client_id', 'client_secret']):
+            raise ValueError("Required parameters (username, password, client_id, client_secret) must be provided.")
+
+        try:
+            self.connection = salesforce_api.Salesforce(
+                username=self.connection_data['username'],
+                password=self.connection_data['password'],
+                client_id=self.connection_data['client_id'],
+                client_secret=self.connection_data['client_secret']
+            )
+            self.is_connected = True
+            return self.connection
+        except AuthenticationError as auth_error:
+            logger.error(f"Authentication error connecting to Salesforce, {auth_error}!")
+            raise
+        except Exception as unknown_error:
+            logger.error(f"Unknwn error connecting to Salesforce, {unknown_error}!")
+            raise
+
+    def check_connection(self) -> StatusResponse:
+        """
+        Checks the status of the connection to the Salesforce API.
+
+        Returns:
+            StatusResponse: An object containing the success status and an error message if an error occurs.
+        """
+        response = StatusResponse(False)
+
+        try:
+            self.connect()
+            response.success = True
+        except (AuthenticationError, ValueError) as known_error:
+            logger.error(f'Connection check to Salesforce failed, {known_error}!')
+            response.error_message = str(known_error)
+        except Exception as unknown_error:
+            logger.error(f'Connection check to Salesforce failed due to an unknown error, {unknown_error}!')
+            response.error_message = str(unknown_error)
+
+        self.is_connected = response.success
+
+        return response
+
+    def native_query(self, query: Text) -> Response:
+        """
+        Executes a native SOQL query on Salesforce and returns the result.
+
+        Args:
+            query (Text): The SQL query to be executed.
+
+        Returns:
+            Response: A response object containing the result of the query or an error message.
+        """
+        connection = self.connect()
+
+        try:
+            results = connection.sobjects.query(query)
+
+            parsed_results = []
+            for result in results:
+                del result['attributes']
+
+                # Check if the result contains any of the other Salesforce resources.
+                if any(key in self.resource_names for key in result.keys()):
+                    # Parse the result to extract the nested resources.
+                    parsed_result = {}
+                    for key, value in result.items():
+                        if key in self.resource_names:
+                            del value['attributes']
+                            parsed_result.update({f'{key}_{sub_key}': sub_value for sub_key, sub_value in value.items()})
+
+                        else:
+                            parsed_result[key] = value
+
+                    parsed_results.append(parsed_result)
+
+                else:
+                    parsed_results.append(result)
+
+            response = Response(
+                RESPONSE_TYPE.TABLE,
+                pd.DataFrame(parsed_results)
+            )
+        except RestRequestCouldNotBeUnderstoodError as rest_error:
+            logger.error(f'Error running query: {query} on Salesforce, {rest_error}!')
+            response = Response(
+                RESPONSE_TYPE.ERROR,
+                error_code=0,
+                error_message=str(rest_error)
+            )
+        except Exception as unknown_error:
+            logger.error(f'Error running query: {query} on Salesforce, {unknown_error}!')
+            response = Response(
+                RESPONSE_TYPE.ERROR,
+                error_code=0,
+                error_message=str(unknown_error)
+            )
+
+        return response

mindsdb/integrations/handlers/salesforce_handler/salesforce_tables.py

@@ -0,0 +1,129 @@
+from typing import Dict, List, Text
+
+from mindsdb_sql_parser.ast import Select, Star, Identifier
+import pandas as pd
+
+from mindsdb.integrations.libs.api_handler import APIResource
+from mindsdb.integrations.utilities.sql_utils import FilterCondition, FilterOperator
+from mindsdb.utilities import log
+
+
+logger = log.getLogger(__name__)
+
+
+def create_table_class(table_name: Text, resource_name: Text) -> APIResource:
+    """
+    Creates a table class for the given Salesforce resource.
+    """
+
+    class AnyTable(APIResource):
+        """
+        This is the table abstraction for any resource of the Salesforce API.
+        """
+
+        def select(self, query: Select) -> pd.DataFrame:
+            """
+            Executes a SELECT SQL query represented by an ASTNode object on the Salesforce resource and retrieves the data (if any).
+
+            Args:
+                query (ASTNode): An ASTNode object representing the SQL query to be executed.
+
+            Returns:
+                pd.DataFrame: A DataFrame containing the data retrieved from the Salesforce resource.
+            """
+            query.from_table = table_name
+
+            # SOQL does not support * in SELECT queries. Replace * with column names.
+            if isinstance(query.targets[0], Star):
+                query.targets = [Identifier(column) for column in self.get_columns()]
+
+            # SOQL does not support column aliases. Remove column aliases.
+            column_aliases = {}
+            for column in query.targets:
+                if column.alias is not None:
+                    column_aliases[column.parts[-1]] = column.alias.parts[-1]
+                    column.alias = None
+
+            client = self.handler.connect()
+
+            query_str = query.to_string()
+
+            # SOQL does not support backticks. Remove backticks.
+            query_str = query_str.replace("`", "")
+            results = client.sobjects.query(query_str)
+
+            for result in results:
+                del result['attributes']
+
+            df = pd.DataFrame(results)
+            df.rename(columns=column_aliases, inplace=True)
+
+            return df
+
+        def add(self, item: Dict) -> None:
+            """
+            Adds a new item to the Salesforce resource.
+
+            Args:
+                contact (Dict): The data to be inserted into the Salesforce resource.
+            """
+            client = self.handler.connect()
+            getattr(client.sobjects, resource_name).insert(item)
+
+        def modify(self, conditions: List[FilterCondition], values: Dict) -> None:
+            """
+            Modifies items in the Salesforce resource based on the specified conditions.
+
+            Args:
+                conditions (List[FilterCondition]): The conditions based on which the items are to be modified.
+                values (Dict): The values to be updated in the items.
+            """
+            client = self.handler.connect()
+
+            ids = self._validate_conditions(conditions)
+
+            for id in ids:
+                getattr(client.sobjects, resource_name).update(id, values)
+
+        def remove(self, conditions: List[FilterCondition]) -> None:
+            """
+            Removes items from the Salesforce resource based on the specified conditions.
+
+            Args:
+                conditions (List[FilterCondition]): The conditions based on which the items are to be removed.
+            """
+            client = self.handler.connect()
+
+            ids = self._validate_conditions(conditions)
+
+            for id in ids:
+                getattr(client.sobjects, resource_name).delete(id)
+
+        def _validate_conditions(self, conditions: List[FilterCondition]) -> None:
+            """
+            Validates the conditions used for filtering items in the Salesforce resource.
+
+            Args:
+                conditions (List[FilterCondition]): The conditions to be validated.
+            """
+            # Salesforce API does not support filtering items based on attributes other than 'Id'. Raise an error if any other column is used.
+            if len(conditions) != 1 or conditions[0].column != 'Id':
+                raise ValueError("Only the 'Id' column can be used to filter items.")
+
+            # Only the 'equals' and 'in' operators can be used on the 'Id' column for deletion. Raise an error if any other operator is used.
+            if conditions[0].op not in [FilterOperator.EQUAL, FilterOperator.IN]:
+                raise ValueError("Only the 'equals' and 'in' operators can be used on the 'Id' column.")
+
+            return conditions[0].value if isinstance(conditions[0].value, list) else [conditions[0].value]
+
+        def get_columns(self) -> List[Text]:
+            """
+            Retrieves the attributes (columns) of the Salesforce resource.
+
+            Returns:
+                List[Text]: A list of Attributes (columns) of the Salesforce resource.
+            """
+            client = self.handler.connect()
+            return [field['name'] for field in getattr(client.sobjects, resource_name).describe()['fields']]
+
+    return AnyTable

mindsdb/integrations/handlers/sap_erp_handler/__about__.py

@@ -0,0 +1,9 @@
+__title__ = "MindsDB SAP ERP handler"
+__package_name__ = "mindsdb_sap_erp_handler"
+__version__ = "0.0.1"
+__description__ = "MindsDB handler for SAP ERP"
+__author__ = "Aditya Azad"
+__github__ = "https://github.com/mindsdb/mindsdb"
+__pypi__ = "https://pypi.org/project/mindsdb/"
+__license__ = "MIT"
+__copyright__ = "Copyright 2023 - mindsdb"

mindsdb/integrations/handlers/sap_erp_handler/__init__.py

@@ -0,0 +1,27 @@
+from mindsdb.integrations.libs.const import HANDLER_TYPE
+
+from .__about__ import __description__ as description
+from .__about__ import __version__ as version
+
+try:
+    from .sap_erp_handler import SAPERPHandler as Handler
+    import_error = None
+except Exception as e:
+    Handler = None
+    import_error = e
+
+title = "SAP ERP"
+name = "sap_erp"
+type = HANDLER_TYPE.DATA
+icon_path = "icon.svg"
+
+__all__ = [
+    "Handler",
+    "version",
+    "name",
+    "type",
+    "title",
+    "description",
+    "import_error",
+    "icon_path",
+]

mindsdb/integrations/handlers/sap_erp_handler/api.py

@@ -0,0 +1,79 @@
+import requests
+from urllib.parse import urljoin
+
+from mindsdb.utilities import log
+
+logger = log.getLogger(__name__)
+
+
+def move_under(d, key_contents_to_move, key_to_move_under=None):
+    """
+    Moves the keys in nested dict with key key_contents_to_move under the dict defined by key_to_move_under.
+    If no key_to_move_under is provided, the keys are moved under d.
+    eg.
+    Calling this on the following dict (d) with key_contents_to_move = "a":
+    {
+        "a": {
+            "b": 1,
+            "c": 2
+        }
+    }
+    results in:
+    {
+        "b": 1,
+        "c": 2
+    }
+    """
+    if key_contents_to_move not in d:
+        return
+    for k, v in d[key_contents_to_move].items():
+        if key_to_move_under:
+            d[key_to_move_under][k] = v
+        else:
+            d[k] = v
+    del d[key_contents_to_move]
+
+
+class SAPERP:
+
+    def __init__(self, url: str, api_key: str) -> None:
+        self.base_url = url
+        self.api_key = api_key
+
+    def _request(self, method: str, relative_endpoint: str, data=None):
+        kwargs = {
+            "method": method,
+            "url": urljoin(self.base_url, relative_endpoint),
+            "headers": {
+                "APIKey": self.api_key,
+                "Accept": "application/json",
+                "DataServiceVersion": "2.0"
+            }
+        }
+        if data is not None:
+            kwargs["data"] = data
+        return requests.request(**kwargs)
+
+    def is_connected(self) -> bool:
+        if self._request("get", "").ok:
+            return True
+        return False
+
+    def get(self, endpoint):
+        """ Common method for all get endpoints """
+        try:
+            resp = self._request("get", endpoint)
+            if resp.ok:
+                resp = resp.json()["d"]
+                if "results" in resp:
+                    resp = resp["results"]
+                else:
+                    resp = [resp]
+            else:
+                resp = []
+            for r in resp:
+                move_under(r, "__metadata")
+            return resp
+        except Exception as e:
+            logger.error(f"Error requesting endpoint {endpoint}: {e}")
+            return {}

mindsdb/integrations/handlers/sap_erp_handler/icon.svg

@@ -0,0 +1,13 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="21" viewBox="0 0 40 21" fill="none">
+  <path fill-rule="evenodd" clip-rule="evenodd" d="M0 21H19.988L39.5441 0.0257568H0V21Z" fill="url(#paint0_linear_155_1848)"/>
+  <path fill-rule="evenodd" clip-rule="evenodd" d="M23.4673 4.19483H19.5561L19.5801 14.0514L16.1728 4.19483H12.7895L9.88605 12.4301C9.57411 10.3456 7.55852 9.62498 5.97483 9.08454C4.91905 8.72424 3.81527 8.1838 3.81527 7.59189C3.81527 7.10292 4.41515 6.66542 5.56692 6.71689C6.35876 6.76836 7.03062 6.81983 8.42234 7.54042L9.76608 5.01836C8.51833 4.32351 6.79067 3.91174 5.35096 3.91174C3.69529 3.91174 2.30357 4.47792 1.46374 5.43013C0.863857 6.09924 0.551919 6.92277 0.527924 7.87498C0.503929 9.16174 0.935842 10.0625 1.87166 10.7831C2.6395 11.4007 3.6473 11.7867 4.51113 12.0698C5.59091 12.4301 6.47873 12.7389 6.45474 13.4081C6.45474 13.6397 6.35876 13.8713 6.19079 14.0514C5.92684 14.3603 5.51893 14.4632 4.94304 14.4632C3.83926 14.4889 3.02342 14.3088 1.72768 13.4853L0.527924 16.0331C1.82366 16.8309 3.21539 17.2169 4.77507 17.2169H5.135C6.50273 17.1912 7.60651 16.8309 8.49433 16.0845C8.54232 16.0331 8.59031 16.0073 8.6383 15.9559L8.49433 16.7794H11.7817L12.3816 15.1581C13.0054 15.3897 13.7013 15.5184 14.4691 15.5184C15.189 15.5184 15.8849 15.3897 16.5087 15.1838L16.9166 16.7794H22.8195L22.8435 13.0735H24.0912C27.1386 13.0735 28.9382 11.4264 28.9382 8.6213C28.9142 5.5588 27.1866 4.19483 23.4673 4.19483ZM14.4691 12.636C14.0132 12.636 13.5813 12.5588 13.2214 12.4044L14.4451 8.23527H14.4691L15.6929 12.4301C15.309 12.5331 14.901 12.636 14.4691 12.636ZM23.6833 10.2169H22.8195V6.84557H23.6833C24.8351 6.84557 25.7469 7.25733 25.7469 8.51836C25.7469 9.83086 24.8351 10.2169 23.6833 10.2169Z" fill="white"/>
+  <defs>
+    <linearGradient id="paint0_linear_155_1848" x1="19.772" y1="0.0257568" x2="19.772" y2="21" gradientUnits="userSpaceOnUse">
+      <stop stop-color="#00AEEF"/>
+      <stop offset="0.212" stop-color="#0097DC"/>
+      <stop offset="0.519" stop-color="#007CC5"/>
+      <stop offset="0.792" stop-color="#006CB8"/>
+      <stop offset="1" stop-color="#0066B3"/>
+    </linearGradient>
+  </defs>
+</svg>

mindsdb/integrations/handlers/sap_erp_handler/sap_erp_handler.py

@@ -0,0 +1,161 @@
+from collections import OrderedDict
+from mindsdb_sql_parser import parse_sql
+
+from mindsdb.integrations.libs.const import HANDLER_CONNECTION_ARG_TYPE as ARG_TYPE
+from mindsdb.integrations.handlers.sap_erp_handler.api import SAPERP
+from mindsdb.integrations.handlers.sap_erp_handler.sap_erp_tables import (
+    AddressEmailAddressTable,
+    AddressFaxNumberTable,
+    AddressHomePageURLTable,
+    AddressPhoneNumberTable,
+    BPAddrDepdntIntlLocNumberTable,
+    BPContactToAddressTable,
+    BPContactToFuncAndDeptTable,
+    BPCreditWorthinessTable,
+    BPDataControllerTable,
+    BPFinancialServicesExtnTable,
+    BPFinancialServicesReportingTable,
+    BPFiscalYearInformationTable,
+    BPRelationshipTable,
+    BuPaAddressUsageTable,
+    BuPaIdentificationTable,
+    BuPaIndustryTable,
+    BusinessPartnerTable,
+    BusinessPartnerAddressTable,
+    BusinessPartnerContactTable,
+    BusinessPartnerPaymentCardTable,
+    BusinessPartnerRatingTable,
+    BusinessPartnerRoleTable,
+    BusinessPartnerTaxNumberTable,
+    BusPartAddrDepdntTaxNumberTable,
+    CustAddrDepdntExtIdentifierTable,
+    CustAddrDepdntInformationTable,
+    CustomerCompanyTable,
+    CustomerCompanyTextTable,
+    CustomerDunningTable,
+    CustomerSalesAreaTable,
+    CustomerSalesAreaTaxTable,
+    CustomerSalesAreaTextTable,
+    CustomerTaxGroupingTable,
+    CustomerTextTable,
+    CustomerUnloadingPointTable,
+    CustomerWithHoldingTaxTable,
+    CustSalesPartnerFuncTable,
+    CustSlsAreaAddrDepdntInfoTable,
+    CustSlsAreaAddrDepdntTaxInfoTable,
+    CustUnldgPtAddrDepdntInfoTable,
+    SupplierTable,
+    SupplierCompanyTable,
+    SupplierCompanyTextTable,
+    SupplierDunningTable,
+    SupplierPartnerFuncTable,
+    SupplierPurchasingOrgTable,
+    SupplierPurchasingOrgTextTable,
+    SupplierTextTable,
+    SupplierWithHoldingTaxTable,
+)
+
+from mindsdb.integrations.libs.api_handler import APIHandler
+from mindsdb.integrations.libs.response import HandlerStatusResponse as StatusResponse
+
+
+class SAPERPHandler(APIHandler):
+
+    def __init__(self, name: str, **kwargs) -> None:
+        super().__init__(name)
+        self.connection = None
+        self.is_connected = False
+        self.api_key = kwargs.get("connection_data", {}).get("api_key", "")
+        self.base_url = kwargs.get("connection_data", {}).get("base_url", "")
+        _tables = [
+            AddressEmailAddressTable,
+            AddressFaxNumberTable,
+            AddressHomePageURLTable,
+            AddressPhoneNumberTable,
+            BPAddrDepdntIntlLocNumberTable,
+            BPContactToAddressTable,
+            BPContactToFuncAndDeptTable,
+            BPCreditWorthinessTable,
+            BPDataControllerTable,
+            BPFinancialServicesExtnTable,
+            BPFinancialServicesReportingTable,
+            BPFiscalYearInformationTable,
+            BPRelationshipTable,
+            BuPaAddressUsageTable,
+            BuPaIdentificationTable,
+            BuPaIndustryTable,
+            BusinessPartnerTable,
+            BusinessPartnerAddressTable,
+            BusinessPartnerContactTable,
+            BusinessPartnerPaymentCardTable,
+            BusinessPartnerRatingTable,
+            BusinessPartnerRoleTable,
+            BusinessPartnerTaxNumberTable,
+            BusPartAddrDepdntTaxNumberTable,
+            CustAddrDepdntExtIdentifierTable,
+            CustAddrDepdntInformationTable,
+            CustomerCompanyTable,
+            CustomerCompanyTextTable,
+            CustomerDunningTable,
+            CustomerSalesAreaTable,
+            CustomerSalesAreaTaxTable,
+            CustomerSalesAreaTextTable,
+            CustomerTaxGroupingTable,
+            CustomerTextTable,
+            CustomerUnloadingPointTable,
+            CustomerWithHoldingTaxTable,
+            CustSalesPartnerFuncTable,
+            CustSlsAreaAddrDepdntInfoTable,
+            CustSlsAreaAddrDepdntTaxInfoTable,
+            CustUnldgPtAddrDepdntInfoTable,
+            SupplierTable,
+            SupplierCompanyTable,
+            SupplierCompanyTextTable,
+            SupplierDunningTable,
+            SupplierPartnerFuncTable,
+            SupplierPurchasingOrgTable,
+            SupplierPurchasingOrgTextTable,
+            SupplierTextTable,
+            SupplierWithHoldingTaxTable,
+        ]
+        for Table in _tables:
+            self._register_table(Table.name, Table(self))
+        self.connect()
+
+    def check_connection(self) -> StatusResponse:
+        resp = StatusResponse(False)
+        if self.connection and not self.connection.is_connected():
+            resp.error = "Client not connected"
+        else:
+            resp.success = True
+        return resp
+
+    def connect(self) -> SAPERP:
+        self.connection = SAPERP(self.base_url, self.api_key)
+        return self.connection
+
+    def native_query(self, query: str) -> StatusResponse:
+        ast = parse_sql(query)
+        return self.query(ast)
+
+
+connection_args = OrderedDict(
+    api_key={
+        'type': ARG_TYPE.STR,
+        'description': 'API Token for accessing SAP ERP',
+        'required': True,
+        'label': 'API Key',
+    },
+    base_url={
+        'type': ARG_TYPE.STR,
+        'description': 'Base URL of the host',
+        'required': True,
+        'label': 'Base URL',
+    }
+)
+
+
+connection_args_example = OrderedDict(
+    api_key='23d6b9e0c2fab7eba2e8b7e452cead47',
+    base_url='https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_BUSINESS_PARTNER/'
+)