Ready to get started?

Download a free trial of the IBM Cloud Data Engine Driver to get started:

 Download Now

Learn more:

IBM Cloud Data Engine Icon IBM Cloud Data Engine JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with IBM Cloud Data Engine.

How to connect to IBM Cloud Data Engine Data with Squirrel SQL client



Connect to IBM Cloud Data Engine data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for IBM Cloud Data Engine enables you to execute queries to IBM Cloud Data Engine data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for IBM Cloud Data Engine data and execute queries.

Add the JDBC Driver for IBM Cloud Data Engine

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for IBM Cloud Data Engine.
  4. In the Example URL box, enter jdbc:ibmclouddataengine:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.ibmclouddataengine.IBMCloudDataEngineDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData IBM Cloud Data Engine Source.
    • Driver: Select the CData JDBC Driver for IBM Cloud Data Engine.
    • URL: Enter jdbc:ibmclouddataengine:
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    IBM Cloud Data Engine uses the OAuth and HMAC authentication standards. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

    Below is a typical connection string:

    jdbc:ibmclouddataengine:Api Key=MyAPIKey;Instance CRN=myInstanceCRN;Region=myRegion;Schema=mySchema;OAuth Client Id=myOAuthClientId;OAuth Client Secret=myOAuthClientSecret;InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query IBM Cloud Data Engine Data

After the metadata has loaded, a new tab for the IBM Cloud Data Engine data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT Id, Status FROM Jobs WHERE UserId = user@domain.com