Load Salesforce Data Cloud Data to a Database Using Embulk

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Salesforce Data Cloud, Embulk easily loads data from Salesforce Data Cloud to any supported destination. In this article, we explain how to use the CData JDBC Driver for Salesforce Data Cloud in Embulk to load Salesforce Data Cloud data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Salesforce Data Cloud data. When you issue complex SQL queries to Salesforce Data Cloud, the driver pushes supported SQL operations, like filters and aggregations, directly to Salesforce Data Cloud and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to Salesforce Data Cloud Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Salesforce Data Cloud\lib).

Embulk supports JDBC connectivity, so you can easily connect to Salesforce Data Cloud and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Salesforce Data Cloud.

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 JDBC connection string for Salesforce Data Cloud:

jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;

Load Salesforce Data Cloud Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

1. Install the JDBC Input Plugin in Embulk.
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

With the input and output plugins installed, we are ready to load Salesforce Data Cloud data into MySQL using Embulk.

Create a Job to Load Salesforce Data Cloud Data

Start by creating a config file in Embulk, using a name like salesforcedatacloud-mysql.yml.

1. For the input plugin options, use the CData JDBC Driver for Salesforce Data Cloud, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver), and the JDBC URL from above
2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (salesforcedatacloud-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.salesforcedatacloud.jar
	driver_class: cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver
	url: jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;
	table: "Account"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Account"
	mode: insert

After creating the file, run the Embulk job.

embulk run salesforcedatacloud-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Salesforce Data Cloud Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.salesforcedatacloud.jar
	driver_class: cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver
	url: jdbc:salesforcedatacloud:InitiateOAuth=GETANDREFRESH;
	query: "SELECT [Account ID], [Account Name] FROM Account WHERE [RecordId] = 1"
out: 
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Account"
	mode: insert

More Information & Free Trial

By using CData JDBC Driver for Salesforce Data Cloud as a connector, Embulk can integrate Salesforce Data Cloud data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.