Ready to get started?

Learn more about the CData JDBC Driver for HPCC or download a free trial:

Download Now

Connect to HPCC Systems Data in DBVisualizer

Integrate HPCC Systems data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for HPCC Systems implements JDBC standards to provide connectivity to HPCC Systems data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to HPCC Systems data in DBVisualizer and use the table editor to load HPCC Systems data.

Create a New JDBC Data Source for HPCC Systems Data

Follow the steps below to use the Driver Manager to provide connectivity to HPCC Systems data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager -> Create a New Driver.
  2. Enter a name for the data source.
  3. Enter the following in the URL Format box: jdbc:hpcc:
    The DBVisualizer Driver Manager.
  4. In the User Specified tab, click the Open File button and select the cdata.jdbc.hpcc.jar file, located in the lib subfolder of the installation directory.
  5. In the Driver Class menu, select the HPCCDriver class, cdata.jdbc.hpcc.HPCCDriver.

Define the Connection to the JDBC Data Source

Follow the steps below to save connection properties in the JDBC URL.

  1. In the Database tab, right-click the Database Connection node and click Create a Database Connection.
  2. In the Connection section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:hpcc: followed by the connection properties in a semicolon-separated list of name-value pairs.

      To connect, set the following connection properties: Set URL to the machine name or IP address of the server and the port the server is running on, for example, https://server:port. The User and Password are required to authenticate to the HPCC Systems cluster specified in the URL. Note that LDAP authentication is not currently supported by our ODBC driver.

      Set Version to the WsSQL Web server version. Note that if you have not already done so, you will need to install the WsSQL service on the HPCC Systems server. The WsSQL Web service is used to interact with the underlying HPCC Systems platform.

      Set Cluster to the target cluster.

      Built-in Connection String Designer

      For assistance in constructing the JDBC URL, use the connection string designer built into the HPCC Systems JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

      java -jar cdata.jdbc.hpcc.jar

      Fill in the connection properties and copy the connection string to the clipboard.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:hpcc:URL=http://127.0.0.1:8510;User=test;password=xA123456;Version=1;Cluster=hthor;
    • Database UserId: The username to use to authenticate to HPCC Systems.
    • Database Password: The password to use to authenticate to HPCC Systems.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the HPCC Systems JDBC Driver, right-click a table and click Open in New Tab.

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.