How to Connect DBeaver to Salesforce Data Cloud via a JDBC Driver

The CData JDBC Driver for Salesforce Data Cloud implements JDBC standards that enable third-party tools to interoperate, from wizards in IDEs to business intelligence tools. This article shows how to connect to Salesforce Data Cloud data with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Salesforce Data Cloud Data

Follow the steps below to load the driver JAR in DBeaver.

1. Open the DBeaver application and, in the "Database" menu, select the "Driver Manager" option. Click "New" to open the "Create new driver" form.
2. In the Settings tab:
   • Set Driver Name to a user-friendly name for the driver (e.g. CData JDBC Driver for Salesforce Data Cloud).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver.
   • Set URL Template to jdbc:salesforcedatacloud:.
   👁 Configure the new driver settings (Salesforce is shown).
   
3. In the Libraries tab, click "Add File," navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\) and select the JAR file (cdata.jdbc.SalesforceDataCloud.jar). 👁 Loading the JDBC JAR file (Salesforce is shown).
   

Create a Connection to Salesforce Data Cloud Data

Follow the steps below to add credentials and other required connection properties.

1. In the "Database" menu, click "New Database Connection."
2. In the "Connect to a database" wizard that results, select the driver you just created (e.g. CData JDBC Driver for Salesforce Data Cloud) and click "Next >." 👁 Selecting the driver (Salesforce is shown).
   
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   Salesforce Data Cloud supports authentication via the OAuth standard.

   OAuth

   Set to OAuth.

   Desktop Applications

   CData provides an embedded OAuth application that simplifies authentication at the desktop.

   You can also authenticate from the desktop via a custom OAuth application, which you configure and register at the Salesforce Data Cloud console. For further information, see Creating a Custom OAuth App in the Help documentation.

   Before you connect, set these properties:

   • : GETANDREFRESH. You can use to avoid repeating the OAuth exchange and manually setting the .
   • (custom applications only): The Client ID assigned when you registered your custom OAuth application.
   • (custom applications only): The Client Secret assigned when you registered your custom OAuth application.

   When you connect, the driver opens Salesforce Data Cloud's OAuth endpoint in your default browser. Log in and grant permissions to the application.

   The driver then completes the OAuth process as follows:

   • Extracts the access token from the callback URL.
   • Obtains a new access token when the old one expires.
   • Saves OAuth values in so that they persist across connections.

   For other OAuth methods, including Web Applications and Headless Machines, refer to the Help documentation.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.salesforcedatacloud.jar
   

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

   👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
   

   Below is a typical connection string:

   jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;
   

   👁 Configuring the JDBC URL (Salesforce is shown).
   
4. Click "Test Connection ..." to ensure you have configured the connection properly. 👁 A successfully configured connection (Salesforce is shown).
   
5. Click "Finish."

Query Salesforce Data Cloud Data

You can now query information from the tables exposed by the connection: Right-click a Table and then click View Table. The data is available on the Data tab.

👁 The results of a query in DBeaver. (Salesforce is shown.)

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for Salesforce Data Cloud and start working with your live Salesforce Data Cloud data in DBeaver. Join the CData Community or reach out to our Support Team if you have any questions.