Repository: mindsdb/mindsdb

Issue:
Support DB2 database integration
Support IBM DB2 database integration 

We need to figure out how to connect, to enable AI-Tables or deploy in DB2 container or DB2 on Cloud

P.D. An apology for incomplete or not answering issue: https://github.com/mindsdb/mindsdb/issues/1167#event-4489203966



Discussion:
HI @eucariop 

Thank you, looking forward to help you, can you describe your use case, what data you have on DB2 and what would you like to predict,

Best regards,

Jorge
@ZoranPandovski  i want to work on this .
please assign it to me and also guide me.
To start you can check https://docs.mindsdb.com/contribute/integrations/ and review the code of the handlers https://github.com/mindsdb/mindsdb/tree/staging/mindsdb/integrations/handlers. If you have more questions we can discuss this on slack

Resolving patch:
diff --git a/mindsdb/integrations/handlers/db2_handler/__about__.py b/mindsdb/integrations/handlers/db2_handler/__about__.py
new file mode 100644
--- /dev/null
+++ b/mindsdb/integrations/handlers/db2_handler/__about__.py
@@ -0,0 +1,9 @@
+__title__ = 'MindsDB IBM DB2 handler'
+__package_name__ = 'mindsdb_db2_handler'
+__version__ = '0.0.1'
+__description__ = "MindsDB handler for IBM DB2"
+__author__ = 'MindsDB Inc'
+__github__ = 'https://github.com/mindsdb/mindsdb'
+__pypi__ = 'https://pypi.org/project/mindsdb/'
+__license__ = 'GPL-3.0'
+__copyright__ = 'Copyright 2022- mindsdb'
diff --git a/mindsdb/integrations/handlers/db2_handler/__init__.py b/mindsdb/integrations/handlers/db2_handler/__init__.py
new file mode 100644
--- /dev/null
+++ b/mindsdb/integrations/handlers/db2_handler/__init__.py
@@ -0,0 +1,20 @@
+from mindsdb.integrations.libs.const import HANDLER_TYPE
+
+try:
+    from .db2_handler import DB2Handler as Handler
+    import_error = None
+except Exception as e:
+    Handler = None
+    import_error = e
+from .__about__ import __version__ as version, __description__ as description
+
+
+title = 'IBM DB2'
+name = 'db2'
+type = HANDLER_TYPE.DATA
+icon_path = 'icon.png'
+
+__all__ = [
+    'Handler', 'version', 'name', 'type', 'title', 'description',
+    'import_error', 'icon_path'
+]
diff --git a/mindsdb/integrations/handlers/db2_handler/db2_handler.py b/mindsdb/integrations/handlers/db2_handler/db2_handler.py
new file mode 100644
--- /dev/null
+++ b/mindsdb/integrations/handlers/db2_handler/db2_handler.py
@@ -0,0 +1,299 @@
+from collections import OrderedDict
+from typing import Optional
+from mindsdb_sql.parser.ast.base import ASTNode
+from mindsdb.integrations.libs.base_handler import DatabaseHandler
+from mindsdb.utilities.log import log
+from mindsdb_sql import parse_sql
+from mindsdb_sql.render.sqlalchemy_render import SqlalchemyRender
+from mindsdb.integrations.libs.response import (
+    HandlerStatusResponse as StatusResponse,
+    HandlerResponse as Response,
+    RESPONSE_TYPE
+)
+from mindsdb.integrations.libs.const import HANDLER_CONNECTION_ARG_TYPE as ARG_TYPE
+
+
+
+import pandas as pd
+import ibm_db_dbi as love
+
+from ibm_db_sa.ibm_db import DB2Dialect_ibm_db as DB2Dialect
+
+
+
+
+class DB2Handler(DatabaseHandler):
+
+
+    name= 'DB2'
+
+    def __init__(self, name: str, connection_data: Optional[dict], **kwargs):
+        """ Initialize the handler
+        Args:
+            name (str): name of particular handler instance
+            connection_data (dict): parameters for connecting to the database
+            **kwargs: arbitrary keyword arguments.
+        """
+        super().__init__(name)
+        
+        self.kwargs = kwargs
+        self.parser = parse_sql
+        self.driver = "{IBM DB2 ODBC DRIVER}"
+        self.database = connection_data['database']
+        self.user = connection_data['user']
+        self.password = connection_data['password']
+        self.schemaName = connection_data['schema_name'] 
+        self.host = connection_data['host']
+        self.port = connection_data['port']
+        self.connString = (
+    "DRIVER={0};"
+    "DATABASE={1};"
+    "HOST={2};"
+    "PORT={3};"
+    "PROTOCOL={4};"
+    "UID={5};"
+    "PWD={6};").format(self.driver, self.database, self.host, self.port,"TCPIP" , self.user, self.password)
+
+        
+        
+
+        self.connection = None
+        self.is_connected = False
+          
+    
+    def connect(self):
+        """ Set up any connections required by the handler
+        Should return output of check_connection() method after attempting
+        connection. Should switch self.is_connected.
+        Returns:
+            Connection Object
+        """
+        if self.is_connected is True:
+            return self.connection
+
+        try:
+            self.connection = love.pconnect(self.connString,'','')
+  
+            self.is_connected= True
+        except Exception as e:
+            log.error(f"Error while connecting to {self.database}, {e}")
+
+
+        return self.connection
+
+
+    def disconnect(self):
+        """ Close any existing connections
+        Should switch self.is_connected.
+        """
+        if self.is_connected is False:
+            return
+        try:
+            self.connection.close()
+        except Exception as e:
+            log.error(f"Error while disconnecting to {self.database}, {e}")
+
+        return 
+
+
+    def check_connection(self) -> StatusResponse:
+        """ Check connection to the handler
+        Returns:
+            HandlerStatusResponse
+        """
+        responseCode = StatusResponse(False)
+        need_to_close = self.is_connected is False
+
+        try:
+            self.connect()
+            responseCode.success = True
+        except Exception as e:
+            log.error(f'Error connecting to database {self.database}, {e}!')
+            responseCode.error_message = str(e)
+        finally:
+            if responseCode.success is True and need_to_close:
+                self.disconnect()
+            if responseCode.success is False and self.is_connected is True:
+                self.is_connected = False
+
+        return responseCode
+
+
+    def native_query(self, query: str) -> StatusResponse:
+        """Receive raw query and act upon it somehow.
+        Args:
+            query (Any): query in native format (str for sql databases,
+                dict for mongo, etc)
+        Returns:
+            HandlerResponse
+        """
+        need_to_close = self.is_connected is False
+        query=query.upper()
+        conn = self.connect()
+        with conn.cursor() as cur:
+            try:
+                cur.execute(query)
+                   
+                if cur._result_set_produced :
+                    result = cur.fetchall() 
+                    response = Response(
+                        RESPONSE_TYPE.TABLE,
+                        data_frame=pd.DataFrame(
+                            result,
+                            columns=[x[0] for x in cur.description]
+                        )
+                    )
+                else:
+                    response = Response(RESPONSE_TYPE.OK)
+                self.connection.commit()
+            except Exception as e:
+                log.error(f'Error running query: {query} on {self.database}!')
+                response = Response(
+                    RESPONSE_TYPE.ERROR,
+                    error_message=str(e)
+                )
+                self.connection.rollback()
+
+        if need_to_close is True:
+            self.disconnect()
+
+        return response
+
+    
+    def query(self, query: ASTNode) -> StatusResponse:
+        """Receive query as AST (abstract syntax tree) and act upon it somehow.
+        Args:
+            query (ASTNode): sql query represented as AST. May be any kind
+                of query: SELECT, INTSERT, DELETE, etc
+        Returns:
+            HandlerResponse
+        """
+        
+
+
+        renderer = SqlalchemyRender(DB2Dialect)
+        query_str = renderer.get_string(query, with_failback=True)
+        return self.native_query(query_str)
+
+
+    def get_tables(self) -> StatusResponse:
+        """ Return list of entities
+        Return list of entities that will be accesible as tables.
+        Returns:
+            HandlerResponse: shoud have same columns as information_schema.tables
+                (https://dev.mysql.com/doc/refman/8.0/en/information-schema-tables-table.html)
+                Column 'TABLE_NAME' is mandatory, other is optional.
+        """
+        self.connect()
+
+
+        result=self.connection.tables(self.schemaName)
+        try:
+            if result:
+                response = Response(
+                    RESPONSE_TYPE.TABLE,
+                    data_frame=pd.DataFrame(
+                        [result[i]['TABLE_NAME'] for i in range(len(result)) ],
+                        columns=['TABLE_NAME']
+                        
+                    )
+                )
+            else:
+                response = Response(RESPONSE_TYPE.OK)
+            
+        except Exception as e:
+            log.error(f'Error running while getting table {e} on ')
+            response = Response(
+                RESPONSE_TYPE.ERROR,
+                error_message=str(e)
+            )
+
+
+
+        return response
+
+    
+    def get_columns(self, table_name: str) -> StatusResponse:
+        """ Returns a list of entity columns
+        Args:
+            table_name (str): name of one of tables returned by self.get_tables()
+        Returns:
+            HandlerResponse: shoud have same columns as information_schema.columns
+                (https://dev.mysql.com/doc/refman/8.0/en/information-schema-columns-table.html)
+                Column 'COLUMN_NAME' is mandatory, other is optional. Hightly
+                recomended to define also 'DATA_TYPE': it should be one of
+                python data types (by default it str).
+        """
+        
+        self.connect()
+
+
+        result=self.connection.columns(table_name=table_name)
+        try:
+            if result:
+                response = Response(
+                    RESPONSE_TYPE.TABLE,
+                    data_frame=pd.DataFrame(
+                        [result[i]['COLUMN_NAME'] for i in range(len(result)) ],
+                        columns=['COLUMN_NAME']
+                        
+                    )
+                )
+            else:
+                response = Response(RESPONSE_TYPE.OK)
+            
+        except Exception as e:
+            log.error(f'Error running while getting table {e} on ')
+            response = Response(
+                RESPONSE_TYPE.ERROR,
+                error_message=str(e)
+            )
+
+
+
+        return response
+
+        
+
+
+
+
+
+connection_args = OrderedDict(
+    host={
+        'type': ARG_TYPE.STR,
+        'description': 'The host name or IP address of the DB2 server/database.'
+    },
+    database={
+        'type': ARG_TYPE.STR,
+        'description': """
+            The database name to use when connecting with the DB2 server.
+        """
+    },
+    user={
+        'type': ARG_TYPE.STR,
+        'description': 'The user name used to authenticate with the DB2 server.'
+    },
+    password={
+        'type': ARG_TYPE.STR,
+        'description': 'The password to authenticate the user with the DB2 server.'
+    },
+    port={
+        'type': ARG_TYPE.INT,
+        'description': 'Specify port to connect DB2 through TCP/IP'
+    },
+    schemaName={
+        'type': ARG_TYPE.STR,
+        'description': 'Specify the schema name '
+    },
+
+)
+
+connection_args_example = OrderedDict(
+    host='127.0.0.1',
+    port='25000',
+    password='1234',
+    user='db2admin',
+    schemaName="db2admin",
+    database="BOOKS",
+)


Test patch:
diff --git a/mindsdb/integrations/handlers/db2_handler/tests/__init__.py b/mindsdb/integrations/handlers/db2_handler/tests/__init__.py
new file mode 100644
diff --git a/mindsdb/integrations/handlers/db2_handler/tests/test_db2_handler.py b/mindsdb/integrations/handlers/db2_handler/tests/test_db2_handler.py
new file mode 100644
--- /dev/null
+++ b/mindsdb/integrations/handlers/db2_handler/tests/test_db2_handler.py
@@ -0,0 +1,49 @@
+import unittest
+from mindsdb.integrations.handlers.db2_handler.db2_handler import DB2Handler
+from mindsdb.api.mysql.mysql_proxy.libs.constants.response_type import RESPONSE_TYPE
+
+
+class DB2HandlerTest(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.kwargs = {
+            "host": "127.0.0.1",
+            "port": "25000",
+            "user": "db2admin",
+            "password": "1234",
+            "database": "Books",
+            "schemaName": "db2admin"
+        }
+        cls.handler = DB2Handler('test_db2_handler', **cls.kwargs)
+
+    def test_0_connect(self):
+         self.handler.connect()
+
+    
+
+    def test_1_drop_table(self):
+        res = self.handler.query("DROP TABLE IF EXISTS LOVE")
+        assert res.type is  not RESPONSE_TYPE.ERROR 
+
+
+    def test_2_create_table(self):
+        res = self.handler.query("CREATE TABLE IF NOT EXISTS LOVE (LOVER varchar(20))")
+        assert res.type is not  RESPONSE_TYPE.ERROR 
+    
+
+    def test_3_get_tables(self):
+        tables = self.handler.get_tables()
+        assert tables.type is not  RESPONSE_TYPE.ERROR
+
+ 
+    def test_4_select_query(self):
+        query = "SELECT * FROM AUTHORS"
+        result = self.handler.native_query(query)
+        assert result.type is   RESPONSE_TYPE.TABLE
+
+    def test_5_check_connection(self):
+         self.handler.check_connection()
+
+        
+if __name__ == '__main__':
+    unittest.main()
\ No newline at end of file
diff --git a/mindsdb/integrations/handlers/mysql_handler/tests/test_mysql_handler.py b/mindsdb/integrations/handlers/mysql_handler/tests/test_mysql_handler.py
--- a/mindsdb/integrations/handlers/mysql_handler/tests/test_mysql_handler.py
+++ b/mindsdb/integrations/handlers/mysql_handler/tests/test_mysql_handler.py
@@ -48,3 +48,4 @@ def test_7_select_query(self):
         query = "SELECT * FROM test_mdb WHERE 'id'='a'"
         result = self.handler.query(query)
         assert result['type'] is RESPONSE_TYPE.TABLE
+