How to Connect DBeaver to Salesforce via a JDBC Driver

The CData JDBC Driver for Salesforce 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 with wizards in DBeaver and browse data in the DBeaver GUI.

Create a JDBC Data Source for Salesforce 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).
   • Set Class Name to the class name for the JDBC driver: cdata.jdbc.salesforce.SalesforceDriver.
   • Set URL Template to jdbc:salesforce:.
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.Salesforce.jar).

Create a Connection to Salesforce 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) and click "Next >."
3. On the Main tab of the configuration wizard, set the JDBC URL, using the required connection properties:

   There are several authentication methods available for connecting to Salesforce: Login, OAuth, and SSO. The Login method requires you to have the username, password, and security token of the user.

   If you do not have access to the username and password or do not wish to require them, you can use OAuth authentication.

   SSO (single sign-on) can be used by setting the SSOProperties, SSOLoginUrl, and TokenUrl connection properties, which allow you to authenticate to an identity provider. See the "Getting Started" chapter in the help documentation for more information.

   Built-in Connection String Designer

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

   java -jar cdata.jdbc.salesforce.jar

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

   Below is a typical connection string:

   jdbc:salesforce:User=username;Password=password;SecurityToken=Your_Security_Token;
4. Click "Test Connection ..." to ensure you have configured the connection properly.
5. Click "Finish."

Query Salesforce 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.

More Information & Free Trial