Connect to Salesforce Data Cloud Data in Aqua Data Studio

The CData JDBC Driver for Salesforce Data Cloud integrates Salesforce Data Cloud data with wizards and analytics in IDEs like Aqua Data Studio. This article shows how to connect to Salesforce Data Cloud data through the connection manager and execute queries.

Create a JDBC Data Source

You can use the connection manager to define connection properties and save them in a new JDBC data source. The Salesforce Data Cloud data source can then be accessed from Aqua Data Studio tools.

1. In Aqua Data Studio, select Register Server from the Servers menu.
2. In the Register Server form, select the 'Generic - JDBC' connection.
3. Enter the following JDBC connection properties:
   • Name: Enter a name for the data source; for example, Salesforce Data Cloud.
   • Driver Location: Click the Browse button and select the cdata.jdbc.salesforcedatacloud.jar file, located in the lib subfolder of the installation directory.
   • Driver: Enter the Driver's class name, cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver.

   • URL: Enter the JDBC URL, which starts with jdbc:salesforcedatacloud: and is followed by a semicolon-separated list of connection properties.

     Salesforce Data Cloud supports authentication via the OAuth standard.

     OAuth

     Set AuthScheme 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:

     • InitiateOAuth: GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
     • OAuthClientId (custom applications only): The Client ID assigned when you registered your custom OAuth application.
     • OAuthClientSecret (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 OAuthSettingsLocation 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.

     A typical JDBC URL is below:
     jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH
     

Query Salesforce Data Cloud Data

You can now query the tables exposed.