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

mindsdb/integrations/handlers/solace_handler/__init__.py

@@ -0,0 +1,19 @@
+from mindsdb.integrations.libs.const import HANDLER_TYPE
+
+from .__about__ import __version__ as version, __description__ as description
+try:
+    from .solace_handler import SolaceHandler as Handler
+    import_error = None
+except Exception as e:
+    Handler = None
+    import_error = e
+
+title = 'Solace'
+name = 'solace'
+type = HANDLER_TYPE.DATA
+icon_path = 'icon.svg'
+
+__all__ = [
+    'Handler', 'version', 'name', 'type', 'title', 'description',
+    'import_error', 'icon_path'
+]

mindsdb/integrations/handlers/solace_handler/icon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" fill="none">
+  <circle cx="20" cy="20" r="20" fill="#00CC91"/>
+</svg>

mindsdb/integrations/handlers/solace_handler/requirements.txt

@@ -0,0 +1 @@
+solace-pubsubplus

mindsdb/integrations/handlers/solace_handler/solace_handler.py

@@ -0,0 +1,169 @@
+import pandas as pd
+
+from solace.messaging.messaging_service import MessagingService, RetryStrategy
+from solace.messaging.resources.topic_subscription import TopicSubscription
+from solace.messaging.receiver.message_receiver import MessageHandler
+from solace.messaging.resources.topic import Topic
+from solace.messaging.receiver.inbound_message import InboundMessage
+
+from mindsdb_sql_parser import parse_sql
+from mindsdb_sql_parser import ast
+
+from mindsdb.api.executor.data_types.response_type import RESPONSE_TYPE
+from mindsdb.integrations.libs.base import DatabaseHandler
+from mindsdb.integrations.libs.response import (
+    HandlerStatusResponse as StatusResponse,
+    HandlerResponse as Response,
+)
+from mindsdb.utilities import log
+
+logger = log.getLogger(__name__)
+
+
+class SolaceHandler(DatabaseHandler):
+
+    def __init__(self, name: str = None, **kwargs):
+        """Registers all API tables and prepares the handler for an API connection.
+
+        Args:
+            name: (str): The handler name to use
+        """
+        super().__init__(name)
+        args = kwargs.get('connection_data', {})
+
+        if 'host' not in args:
+            raise ValueError('Host parameter is required')
+
+        self.connection_args = args
+        self.messaging_service = None
+        self.is_connected = False
+
+    def connect(self):
+
+        broker_props = {
+            "solace.messaging.transport.host": self.connection_args['host'],
+            "solace.messaging.service.vpn-name": self.connection_args.get('vpn-name', 'default'),
+            "solace.messaging.authentication.scheme.basic.username": self.connection_args.get('username'),
+            "solace.messaging.authentication.scheme.basic.password": self.connection_args.get('password')
+        }
+
+        self.messaging_service = MessagingService\
+            .builder()\
+            .from_properties(broker_props) \
+            .with_reconnection_retry_strategy(RetryStrategy.parametrized_retry(20, 3)) \
+            .build()
+
+        self.messaging_service.connect()
+
+        self.direct_publisher = self.messaging_service\
+            .create_direct_message_publisher_builder()\
+            .build()
+        self.direct_publisher.start()
+
+        # TODO support persistent_publisher ?
+
+        self.is_connected = True
+        return self.messaging_service
+
+    def disconnect(self):
+
+        if self.is_connected is False:
+            return
+
+        self.direct_publisher.terminate()
+        self.messaging_service.disconnect()
+        self.is_connected = False
+        return self.is_connected
+
+    def check_connection(self) -> StatusResponse:
+
+        response = StatusResponse(False)
+
+        try:
+            self.connect()
+            response.success = True
+        except Exception as e:
+            logger.error(f'Error connecting to Solace: {e}!')
+            response.error_message = e
+
+        if response.success is False:
+            self.is_connected = False
+        return response
+
+    def native_query(self, query: str = None) -> Response:
+        ast = parse_sql(query)
+        return self.query(ast)
+
+    def query(self, query: ast.ASTNode):
+        if isinstance(query, ast.Insert):
+            result = self.handle_insert(query)
+        else:
+            raise NotImplementedError
+        return result
+
+    def get_columns(self, table_name: str) -> Response:
+        df = pd.DataFrame([], columns=['Field'])
+        df['Type'] = 'str'
+
+        return Response(RESPONSE_TYPE.TABLE, df)
+
+    def get_tables(self) -> Response:
+        df = pd.DataFrame([], columns=['table_name', 'table_type'])
+
+        return Response(RESPONSE_TYPE.TABLE, df)
+
+    def handle_insert(self, query: ast.Insert):
+
+        message_builder = self.messaging_service.message_builder()
+
+        topic_name = '/'.join(query.table.parts)
+
+        column_names = [col.name for col in query.columns]
+        for insert_row in query.values:
+            data = dict(zip(column_names, insert_row))
+
+            outbound_message = message_builder.build(data)
+            self.direct_publisher.publish(destination=Topic.of(topic_name), message=outbound_message)
+
+        return Response(RESPONSE_TYPE.OK)
+
+    def subscribe(self, stop_event, callback, table_name, columns=None, **kwargs):
+
+        class MessageHandlerImpl(MessageHandler):
+            def on_message(self, message: 'InboundMessage'):
+                # Check if the payload is a dict
+                payload = message.get_payload_as_dictionary()
+                if payload is not None:
+                    data = payload
+                else:
+                    # check as string
+                    payload = message.get_payload_as_string()
+                    if payload is None:
+                        payload = message.get_payload_as_bytes()
+                        if isinstance(payload, bytearray):
+                            payload = payload.decode()
+                    data = {'data': payload}
+
+                if columns is not None:
+                    updated_columns = data.keys()
+                    if not set(columns) & set(updated_columns):
+                        # skip
+                        return
+
+                callback(data)
+
+        table = ast.Identifier(table_name)
+        topic_name = '/'.join(table.parts)
+
+        topics = [TopicSubscription.of(topic_name)]
+        direct_receiver = self.messaging_service\
+            .create_direct_message_receiver_builder()\
+            .with_subscriptions(topics)\
+            .build()
+
+        direct_receiver.start()
+        direct_receiver.receive_async(MessageHandlerImpl())
+
+        stop_event.wait()
+
+        direct_receiver.terminate()

mindsdb/integrations/handlers/solr_handler/__about__.py

@@ -0,0 +1,9 @@
+__title__ = 'MindsDB Solr handler'
+__package_name__ = 'mindsdb_solr_handler'
+__version__ = '0.0.1'
+__description__ = "MindsDB handler for Solr"
+__author__ = 'Biswadip Paul'
+__github__ = 'https://github.com/mindsdb/mindsdb'
+__pypi__ = 'https://pypi.org/project/mindsdb/'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2022- mindsdb'

mindsdb/integrations/handlers/solr_handler/__init__.py

@@ -0,0 +1,20 @@
+from mindsdb.integrations.libs.const import HANDLER_TYPE
+
+from .__about__ import __version__ as version, __description__ as description
+from .connection_args import connection_args, connection_args_example
+try:
+    from .solr_handler import SolrHandler as Handler
+    import_error = None
+except Exception as e:
+    Handler = None
+    import_error = e
+
+title = 'Apache Solr'
+name = 'solr'
+type = HANDLER_TYPE.DATA
+icon_path = 'icon.svg'
+
+__all__ = [
+    'Handler', 'version', 'name', 'type', 'title', 'description',
+    'connection_args', 'connection_args_example', 'import_error', 'icon_path'
+]

mindsdb/integrations/handlers/solr_handler/connection_args.py

@@ -0,0 +1,46 @@
+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 user name used to authenticate with the Solr server.'
+    },
+    password={
+        'type': ARG_TYPE.PWD,
+        'description': 'The password to authenticate the user with the Solr server.',
+        'secret': True
+    },
+    host={
+        'type': ARG_TYPE.STR,
+        'description': 'The host name or IP address of the Solr server. NOTE: use \'127.0.0.1\' instead of \'localhost\' to connect to local server.'
+    },
+    port={
+        'type': ARG_TYPE.INT,
+        'description': 'The TCP/IP port of the Solr server. Must be an integer.'
+    },
+    server_path={
+        'type': ARG_TYPE.STR,
+        'description': 'The server path connecting with the Solr server. Defaults to solr when not provided.'
+    },
+    collection={
+        'type': ARG_TYPE.STR,
+        'description': 'The collection name to use for the query in the Solr server.'
+    },
+    use_ssl={
+        'type': ARG_TYPE.BOOL,
+        'description': 'The flag to set ssl for the query in the Solr server.Defaults to false.'
+    }
+)
+
+connection_args_example = OrderedDict(
+    username = "demo_user",
+    password =  "demo_password",
+    host = "127.0.0.1",
+    port = 8981,
+    server_path = "solr",
+    collection = "gettingstarted",
+    use_ssl = False,
+)

mindsdb/integrations/handlers/solr_handler/icon.svg

@@ -0,0 +1,10 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="38" height="37" viewBox="0 0 38 37" fill="none">
+  <path d="M32.7435 5.90051L14.2897 25.4937L37.4628 15.044C36.7972 11.541 35.1031 8.39419 32.7435 5.90051Z" fill="#D93321"/>
+  <path d="M18.767 0.0820312C16.2258 0.0820312 13.8056 0.557018 11.567 1.50699L9.0863 21.9314L21.4292 0.260153C20.5821 0.141406 19.6745 0.0820312 18.767 0.0820312Z" fill="#D93321"/>
+  <path d="M37.7653 16.1127L15.8022 28.1654L36.4342 25.7905C37.4023 23.5343 37.9468 21.1 37.9468 18.547C37.9468 17.7157 37.8863 16.8845 37.7653 16.1127Z" fill="#D93321"/>
+  <path d="M29.3552 33.7466C31.8359 32.1435 33.8325 29.9467 35.2846 27.3937L15.9838 31.1342L29.3552 33.7466Z" fill="#D93321"/>
+  <path d="M22.6997 0.438354L11.93 23.2971L31.8964 5.18822C29.4157 2.87266 26.2695 1.21021 22.6997 0.438354Z" fill="#D93321"/>
+  <path d="M20.4611 36.7747C22.5183 36.5966 24.5149 36.1216 26.33 35.3497L15.4998 34.1029L20.4611 36.7747Z" fill="#D93321"/>
+  <path d="M2.00732 10.9473C1.16026 12.7878 0.615717 14.7472 0.434204 16.8846L3.33841 21.9907L2.00732 10.9473Z" fill="#D93321"/>
+  <path d="M10.4174 2.21948C7.75522 3.58507 5.51657 5.60376 3.82245 8.03807L6.54514 21.4564L10.4174 2.21948Z" fill="#D93321"/>
+</svg>

mindsdb/integrations/handlers/solr_handler/requirements.txt

@@ -0,0 +1 @@
+sqlalchemy-solr

mindsdb/integrations/handlers/solr_handler/solr_handler.py

@@ -0,0 +1,176 @@
+from typing import Optional
+import pandas as pd
+
+from sqlalchemy import create_engine
+
+from mindsdb_sql_parser import parse_sql
+from mindsdb_sql_parser.ast.base import ASTNode
+
+from mindsdb.utilities import log
+from mindsdb.integrations.libs.base import DatabaseHandler
+from mindsdb.integrations.libs.response import (
+    HandlerStatusResponse as StatusResponse,
+    HandlerResponse as Response,
+    RESPONSE_TYPE
+)
+
+
+logger = log.getLogger(__name__)
+
+class SolrHandler(DatabaseHandler):
+    """
+    This handler handles connection and execution of the Solr SQL statements.
+    """
+
+    name = 'solr'
+
+    def __init__(self, name: str, connection_data: Optional[dict], **kwargs):
+        super().__init__(name)
+        self.parser = parse_sql
+        self.dialect = 'solr'
+
+        if ('host' not in connection_data) or ('port' not in connection_data) or ('collection' not in connection_data):
+            raise Exception("The host, port and collection parameter should be provided!")
+
+        optional_parameters = ['use_ssl', 'username', 'password']
+        for parameter in optional_parameters:
+            if parameter not in connection_data:
+                connection_data[parameter] = None
+
+        if connection_data.get('use_ssl', False):
+            connection_data['use_ssl'] = True
+        else:
+            connection_data['use_ssl'] = False
+
+        self.connection_data = connection_data
+        self.kwargs = kwargs
+
+        self.connection = None
+        self.is_connected = False
+
+    def __del__(self):
+        if self.is_connected is True:
+            self.disconnect()
+
+    def connect(self):
+        """
+        Set up the connection required by the handler.
+        Returns:
+            HandlerStatusResponse
+        """
+        if self.is_connected is True:
+            return self.connection
+
+        config = {
+            'username': self.connection_data.get('username'),
+            'password': self.connection_data.get('password'),
+            'host': self.connection_data.get('host'),
+            'port': self.connection_data.get('port'),
+            'server_path': self.connection_data.get('server_path', 'solr'),
+            'collection': self.connection_data.get('collection'),
+            'use_ssl': self.connection_data.get('use_ssl')
+        }
+
+        connection = create_engine("solr://{username}:{password}@{host}:{port}/{server_path}/{collection}/sql?use_ssl={use_ssl}".format(**config))
+        self.is_connected = True
+        self.connection = connection.connect()
+        return self.connection
+
+    def disconnect(self):
+        """
+        Close any existing connections.
+        """
+        if self.is_connected is False:
+            return
+        self.connection.close()
+        self.is_connected = False
+        return
+
+    def check_connection(self) -> StatusResponse:
+        """
+        Check the connection of the Solr database
+        Returns:
+            HandlerStatusResponse
+        """
+
+        response = StatusResponse(False)
+        need_to_close = self.is_connected is False
+
+        try:
+            self.connect()
+            response.success = True
+        except Exception as e:
+            logger.error(f'Error connecting to Solr {self.connection_data["host"]}, {e}!')
+            response.error_message = str(e)
+
+        if response.success is True and need_to_close:
+            self.disconnect()
+        if response.success is False and self.is_connected is True:
+            self.is_connected = False
+
+        return response
+
+    def native_query(self, query: str) -> Response:
+        """
+        Receive raw query and act upon it somehow.
+        Args:
+            query (str): query in native format
+        Returns:
+            HandlerResponse
+        """
+
+        need_to_close = self.is_connected is False
+
+        connection = self.connect()
+
+        try:
+            result = connection.execute(query)
+            columns = list(result.keys())
+            if result:
+                response = Response(
+                    RESPONSE_TYPE.TABLE,
+                    pd.DataFrame(
+                        result,
+                        columns = columns
+                    )
+                )
+            else:
+                response = Response(RESPONSE_TYPE.OK)
+
+        except Exception as e:
+            logger.error(f'Error running query: {query} on {self.connection_data["host"]}!')
+            response = Response(
+                RESPONSE_TYPE.ERROR,
+                error_message=str(e)
+            )
+
+        if need_to_close is True:
+            self.disconnect()
+
+        return response
+
+    def query(self, query: ASTNode) -> Response:
+        """
+        Retrieve the data from the SQL statement.
+        """
+        return self.native_query(query.to_string())
+
+    def get_tables(self) -> Response:
+        """
+        Get a list with all of the tables in Solr
+        """
+        result = {}
+        result['data_frame'] = pd.DataFrame([self.connection_data.get('collection')])
+        df = result.data_frame
+        result.data_frame = df.rename(columns={df.columns[0]: 'table_name'})
+        return result
+
+    def get_columns(self, table_name) -> Response:
+        """
+        Show details about the table
+        """
+        q = f"select * from {table_name} limit 1"
+        result = self.native_query(q)
+        df = pd.DataFrame([[col] for col in result.data_frame.columns])
+        result.data_frame = df.rename(columns={df.columns[0]: 'column_name'})
+        return result

mindsdb/integrations/handlers/solr_handler/tests/test_solr_handler.py

@@ -0,0 +1,38 @@
+import unittest
+
+from mindsdb.integrations.handlers.solr_handler.solr_handler import SolrHandler
+from mindsdb.api.executor.data_types.response_type import RESPONSE_TYPE
+
+
+class SolrHandlerTest(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.kwargs = {
+            "username": "demo_user",
+            "password": "demo_password",
+            "host": "172.22.0.4",
+            "port": 8983,
+            "server_path": "solr",
+            "collection": "gettingstarted",
+            "use_ssl": False
+        }
+        cls.handler = SolrHandler('test_solr_handler', **cls.kwargs)
+
+    def test_0_connect(self):
+        self.handler.check_connection()
+
+    def test_2_get_tables(self):
+        tbls = self.handler.get_tables()
+        assert tbls['type'] is not RESPONSE_TYPE.ERROR
+
+    def test_6_describe_table(self):
+        described = self.handler.get_columns("gettingstarted")
+        assert described['type'] is RESPONSE_TYPE.TABLE
+
+    def test_7_select_query(self):
+        query = "SELECT * FROM gettingstarted WHERE id='apple' limit 1000"
+        result = self.handler.query(query)
+        assert result['type'] is RESPONSE_TYPE.TABLE
+
+if __name__ == '__main__':
+    unittest.main()

mindsdb/integrations/handlers/spacy_handler/__about__.py

@@ -0,0 +1,9 @@
+__title__ = 'MindsDB Spacy handler'
+__package_name__ = 'mindsdb_spacy_handler'
+__version__ = '0.0.1'
+__description__ = "MindsDB handler for Spacy"
+__author__ = 'Ton Hoang Nguyen (Bill)'
+__github__ = 'https://github.com/mindsdb/mindsdb'
+__pypi__ = 'https://pypi.org/project/mindsdb/'
+__license__ = 'MIT'
+__copyright__ = 'Copyright 2022- mindsdb'

mindsdb/integrations/handlers/spacy_handler/__init__.py

@@ -0,0 +1,19 @@
+from mindsdb.integrations.libs.const import HANDLER_TYPE
+
+from .__about__ import __version__ as version, __description__ as description
+try:
+    from .spacy_handler import SpacyHandler as Handler
+    import_error = None
+except Exception as e:
+    Handler = None
+    import_error = e
+
+title = 'spaCy'
+name = 'spacy'
+type = HANDLER_TYPE.ML
+icon_path = 'icon.svg'
+permanent = False
+
+__all__ = [
+    'Handler', 'version', 'name', 'type', 'title', 'description', 'import_error', 'icon_path'
+]

mindsdb/integrations/handlers/spacy_handler/icon.svg

@@ -0,0 +1,3 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="40" height="40" viewBox="0 0 40 40" fill="none">
+  <path d="M6.54199 18.8845C5.73072 18.7944 5.67063 17.7746 4.631 17.8648C4.12622 17.8648 3.65748 18.062 3.65748 18.4958C3.65748 19.1493 4.73316 19.2113 5.38218 19.3746C6.48791 19.6901 7.55758 19.9042 7.55758 21.031C7.55758 22.462 6.36171 22.9577 4.78124 22.9577C3.45917 22.9577 2.11908 22.5183 2.11908 21.3803C2.11908 21.0648 2.44359 20.8169 2.75607 20.8169C3.15269 20.8169 3.29091 20.9746 3.42913 21.2338C3.73561 21.7408 4.07814 22.0113 4.93147 22.0113C5.47232 22.0113 6.02518 21.8197 6.02518 21.3803C6.02518 20.7549 5.34612 20.6197 4.64302 20.4676C3.39908 20.1408 2.32941 19.9718 2.20321 18.676C2.071 16.4676 6.98068 16.3831 7.26312 18.3211C7.25711 18.6704 6.90856 18.8845 6.54199 18.8845ZM12.3831 16.9465C14.1078 16.9465 15.0873 18.2986 15.0873 19.9662C15.0873 21.6394 14.1379 22.9859 12.3831 22.9859C11.4096 22.9859 10.8026 22.5972 10.364 22V24.2084C10.364 24.8732 10.1356 25.1944 9.6188 25.1944C8.98781 25.1944 8.87363 24.8169 8.87363 24.2084V17.7859C8.87363 17.262 9.108 16.9408 9.6188 16.9408C10.0995 16.9408 10.364 17.2958 10.364 17.7859V17.9662C10.8507 17.3915 11.4096 16.9465 12.3831 16.9465ZM11.9745 21.8366C12.9841 21.8366 13.4348 20.9634 13.4348 19.9437C13.4348 18.9465 12.978 18.0507 11.9745 18.0507C10.9228 18.0507 10.4361 18.862 10.4361 19.9437C10.4361 20.9972 10.9288 21.8366 11.9745 21.8366ZM16.2592 18.5239C16.2592 17.3634 17.6834 16.9465 19.0656 16.9465C21.0066 16.9465 21.8058 17.476 21.8058 19.2338V20.9239C21.8058 21.3239 22.0703 22.1239 22.0703 22.3662C22.0703 22.7324 21.7097 22.9634 21.3251 22.9634C20.8984 22.9634 20.5799 22.4901 20.3516 22.1521C19.7206 22.6253 19.0535 22.9634 18.0319 22.9634C16.9022 22.9634 16.0128 22.338 16.0128 21.307C16.0128 20.3944 16.7099 19.8704 17.5512 19.6901C17.5512 19.6958 20.2554 19.0929 20.2554 19.0873C20.2554 18.3098 19.961 17.9662 19.0896 17.9662C18.3204 17.9662 17.9298 18.1634 17.6293 18.5972C17.3889 18.9239 17.419 19.1211 16.9563 19.1211C16.5837 19.1155 16.2592 18.8789 16.2592 18.5239ZM18.5668 22.0113C19.7506 22.0113 20.2494 21.4253 20.2494 20.2591V20.0113C19.9309 20.1127 18.6449 20.4113 18.2964 20.462C17.9238 20.5296 17.5512 20.7887 17.5512 21.2C17.5632 21.6507 18.056 22.0113 18.5668 22.0113ZM27.2624 14.7437C28.933 14.7437 30.7418 15.6789 30.7418 17.1662C30.7418 17.5493 30.4353 17.8648 30.0327 17.8648C29.4858 17.8648 29.4077 17.5887 29.1673 17.2C28.7647 16.507 28.29 16.0451 27.2564 16.0451C25.6579 16.0338 24.9427 17.3183 24.9427 18.9183C24.9427 20.5296 25.5377 21.6901 27.1903 21.6901C28.29 21.6901 28.8969 21.0929 29.2094 20.3211C29.3356 19.9662 29.564 19.6225 30.0387 19.6225C30.4113 19.6225 30.7839 19.9775 30.7839 20.3606C30.7839 21.938 29.0652 23.031 27.2984 23.031C25.3634 23.031 24.2697 22.2648 23.6688 20.9915C23.3743 20.3831 23.188 19.7521 23.188 18.8845C23.176 16.4394 24.6964 14.7437 27.2624 14.7437ZM36.8173 16.9465C37.244 16.9465 37.4903 17.2056 37.4903 17.6113C37.4903 17.7746 37.3521 18.1014 37.298 18.276L35.2428 23.3408C34.7861 24.4394 34.4436 25.2 32.8872 25.2C32.148 25.2 31.505 25.138 31.505 24.5352C31.505 24.1859 31.7874 24.0113 32.178 24.0113C32.2502 24.0113 32.3703 24.0451 32.4425 24.0451C32.5566 24.0451 32.6348 24.0789 32.7069 24.0789C33.4881 24.0789 33.5963 23.3296 33.8727 22.8113L31.8896 18.2084C31.7754 17.9606 31.6973 17.7915 31.6973 17.6451C31.6973 17.2394 32.0338 16.9465 32.4845 16.9465C32.9893 16.9465 33.1876 17.3183 33.3138 17.7239L34.6239 21.3746L35.9339 18C36.1322 17.476 36.1503 16.9465 36.8173 16.9465Z" fill="#09A4D7"/>
+</svg>

mindsdb/integrations/handlers/spacy_handler/requirements.txt

@@ -0,0 +1 @@
+spacy