Zoomdata Version

Adding a JDBC Driver

Overview

Starting in Zoomdata v2.5.3, a change has been made to how JDBC drivers for certain connectors are made available. Specifically, for the following list of Zoomdata connectors, the JDBC drivers are longer included into the installation package:

This approach allows you the flexibility to add a specific JDBC driver that meets your support policies or operational needs. As a result, in order to connect to and visualize data from Zoomdata v2.5.3 to these particular sources, you first must install the JDBC driver. This should be done immediately after installing or upgrading to Zoomdata v2.5.3.

Caveats

If the JDBC driver for the Zoomdata connector is not configured, that particular connector server will not start up and the corresponding connector cannot be enabled by the Zoomdata Administrator.

For more information, see Managing Connectors in Zoomdata.

If you are downloading your JDBC driver to a Windows environment, use caution when transferring the drive over to your Zoomdata instance in order not to corrupt the drive. For example, if you are using WinSCP, use the binary transfer mode.

In the case where Zoomdata was upgraded to v2.5.3, this also means that charts and dashboards created for that data source will no longer be available until the JDBC driver is installed and the connector enabled.

Install a JDBC Driver

In order to use any of the data sources listed above, perform the following steps to install the needed JDBC driver after successful installation of Zoomdata services:

  1. Download the required driver from the vendor’s site to the corresponding Zoomdata instance. Place the required driver in the following folder: /usr/local/share/java/zoomdata
    If this folder does not exist, you need to create it in the location mentioned above.
    See Table 1 for resources for vendor’s JDBC drivers.
Table 1
Connector Link to JDBC Driver License Type Supported Version
Aurora http://central.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/1.3.2/mariadb-java-client-1.3.2.jar LGPL 1.3.2
Microsoft SQL Server https://www.microsoft.com/en-us/download/details.aspx?id=54629 Commercial 4.0.0
MemSQL http://central.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/1.3.2/mariadb-java-client-1.3.2.jar LGPL 1.3.2
MySQL http://central.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/1.3.2/mariadb-java-client-1.3.2.jar LGPL 1.3.2
Redshift http://docs.aws.amazon.com/redshift/latest/mgmt/configure-jdbc-connection.html#download-jdbc-driver Commercial 1.2.1.1001
Oracle http://www.oracle.com/technetwork/database/features/jdbc/jdbc-drivers-12c-download-1958347.html Commercial 12.1.0.2
Teradata http://downloads.teradata.com/download/connectivity/jdbc-driver Commercial 15.00.00.30

Keep in mind that the Zoomdata Administrator must have read-level access rights to the JDBC driver (*.jar) file.

  1. Use the following command to access and open the configuration file:

vi /etc/zoomdata/edc-connector_name.properties

  • If you are not logged in as a root user, then you need to enter sudo vi /etc/zoomdata/edc-connector_name.properties in order to create the desired file.
  • If the configuration file does not exist, this command creates it.

  • Replace connector_name with the name of the data source driver you are configuring:
  • Table 2
    Connector Connector Property File Name
    Aurora edc-aurora.properties
    Microsoft SQL Server edc-mssql.properties
    MemSQL edc-memsql.properties
    MySQL edc-mysql.properties
    Redshift edc-redshift.properties
    Oracle edc-oracle.properties
    Teradata edc-teradata.properties

     

    For guidance on editing property files in Zoomdata, refer to the article Managing Configurations in Zoomdata.

    1. In the edc-connector_name.properties file, add the following property:

    datasource.driver-config.jar-path=path_to_your_JDBC_driver_file

    In case you need to add multiple paths, use a comma separated list:

    datasource.driver-config.jar-path=path_to_your_JDBC_driver_file,path_to_your_JDBC_driver_file_2

    1. Save your changes to the properties file.
    2. Restart the corresponding connector by running the following command:

      • For CentOS 7 and Ubuntu v16:

        systemctl restart zoomdata-edc-connector_name

      • For CentOS 6 and Ubuntu v14:

        service zoomdata-edc-connector_name restart

    Once this is done, the Zoomdata Administrator needs to log in as the Supervisor, access the Connectors page and make sure that connector is enabled so that it appears in the Data Sources page.

    After the JDBC driver has been configured and the connector enabled, users that have access privileges to connect Zoomdata to their data source are able to do so from the Data Sources page.

    If you have issues with your driver after configuration or the connector does not show up as enabled, see Checking your JDBC driver to make sure driver is not corrupt for troubleshooting steps.