FM: Install JDBC Driver SetupAction

Author: Thibaud Baas

dataikuapi/fm/instancesettingstemplates.py

@@ -55,14 +55,14 @@ def __init__(self, setupActionType, params=None):
     @staticmethod
     def add_authorized_key(ssh_key):
         """
-        Return a ADD_AUTHORIZED_KEY SetupAction
+        Return a ADD_AUTHORIZED_KEY FMSetupAction
         """
         return FMSetupAction(FMSetupActionType.ADD_AUTHORIZED_KEY, {"sshKey": ssh_key })
 
     @staticmethod
     def run_ansible_task(stage, yaml_string):
         """
-        Return a RUN_ANSIBLE_TASK SetupAction
+        Return a RUN_ANSIBLE_TASK FMSetupAction
 
         :param object stage: a :class:`dataikuapi.fm.instancesettingstemplates.FMSetupActionStage`
         :param str yaml_string: a yaml encoded string defining the ansibles tasks to run
@@ -72,7 +72,7 @@ def run_ansible_task(stage, yaml_string):
     @staticmethod
     def install_system_packages(packages):
         """
-        Return an INSTALL_SYSTEM_PACKAGES SetupAction
+        Return an INSTALL_SYSTEM_PACKAGES FMSetupAction
 
         :param list packages: List of packages to install
         """
@@ -81,13 +81,28 @@ def install_system_packages(packages):
     @staticmethod
     def setup_advanced_security(basic_headers = True, hsts = False):
         """
-        Return an SETUP_ADVANCED_SECURITY SetupAction
+        Return an SETUP_ADVANCED_SECURITY FMSetupAction
 
         :param boolean basic_headers: Optional, Prevent browsers to render Web content served by DSS to be embedded into a frame, iframe, embed or object tag. Defaults to True
         :param boolean hsts: Optional,  Enforce HTTP Strict Transport Security. Defaults to False
         """
         return FMSetupAction(FMSetupActionType.SETUP_ADVANCED_SECURITY, {"basic_headers": basic_headers, "hsts": hsts})
 
+    @staticmethod
+    def install_jdbc_driver(database_type, url, paths_in_archive=None, http_headers=None, http_username=None, http_password=None, datadir_subdirectory=None):
+        """
+        Return a INSTALL_JDBC_DRIVER FMSetupAction
+
+        :param object database_type: a :class:`dataikuapi.fm.instancesettingstemplates.FMSetupActionAddJDBCDriverDatabaseType`
+        :param str url: The full address to the driver. Supports http(s)://, s3://, abs:// or file:// endpoints
+        :param list paths_in_archive: Optional, must be used when the driver is shipped as a tarball or a ZIP file. Add here all the paths to find the JAR files in the driver archive. Paths are relative to the top of the archive. Wildcards are supported.
+        :param dict http_headers: Optional, If you download the driver from a HTTP(S) endpoint, add here the headers you want to add to the query. This setting is ignored for any other type of download.
+        :param str http_username: Optional, If the HTTP(S) endpoint expect a Basic Authentication, add here the username. To explicitely specify which Assigned Identity use if the machine have several, set the client_id here. To authenticate with a SAS Token on Azure Blob Storage (not recommended), use "token" as the value here.
+        :param str http_password: Optional, If the HTTP(S) endpoint expect a Basic Authentication, add here the password. To authenticate with a SAS Token on Azure Blob Storage (not recommended), store the token in this field.
+        :param str datadir_subdirectory: Optional, Some drivers are shipped with a high number of JAR files along with them. In that case, you might want to install them under an additional level in the DSS data directory. Set the name of this subdirectory here. Not required for most drivers.
+        """
+        return FMSetupAction(FMSetupActionType.INSTALL_JDBC_DRIVER, {"url": url, "dbType": database_type.value, "pathsInArchive": paths_in_archive, "headers": http_headers, "username": http_username, "password": http_password, "subpathInDatadir": datadir_subdirectory})
+
 class FMSetupActionType(Enum):
     RUN_ANSIBLE_TASKS="RUN_ANSIBLE_TASKS"
     INSTALL_SYSTEM_PACKAGES="INSTALL_SYSTEM_PACKAGES"
@@ -106,3 +121,12 @@ class FMSetupActionStage(Enum):
     after_dss_startup="after_dss_startup"
     after_install="after_install"
     before_install="before_install"
+
+class FMSetupActionAddJDBCDriverDatabaseType(Enum):
+    mysql="mysql"
+    mssql="mssql"
+    oracle="oracle"
+    mariadb="mariadb"
+    snowflake="snowflake"
+    athena="athena"
+    bigquery="bigquery"