Load Salesforce Data to a Database Using Embulk

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

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

Getting Started

---

Configure a JDBC Connection to Salesforce 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\lib).

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

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

OAuth Authentication (default)

The default authentication mechanism (and the one preferred by Salesforce) is OAuth. To use OAuth with CData's embedded OAuth application, leave the connection properties blank. If you have configured your own custom OAuth application with Salesforce (see the Help documentation for more information), set OAuthClientId, OAuthClientSecret, and CallbackURL to the properties for you application. Set InitiateOAuth to the desired OAuth flow ("GETANDREFRESH" will have the connector manage the entire OAuth flow).

Login (or Basic) Authentication

If you do not wish do not wish to use OAuth authentication, you can use Login (or basic) authentication. Set AuthScheme to Basic, and set the User, Password, and SecurityToken properties. You can configure your security token in Salesforce.

SSO (single sign-on) Authentication

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

Multi-Factor Authentication (MFA)

If your Salesforce org has MFA enforcement enabled, set MFACode to the time-based one-time passcode (TOTP) generated by your authenticator app (such as Salesforce Authenticator or Google Authenticator). MFACode applies to both OAuth and Login authentication flows.

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.

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

Below is a typical JDBC connection string for Salesforce:

jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode

Load Salesforce 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 into MySQL using Embulk.

Create a Job to Load Salesforce Data

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

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

Sample Config File (salesforce-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.salesforce.jar
	driver_class: cdata.jdbc.salesforce.SalesforceDriver
	url: jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode
	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 salesforce-mysql.yml

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

Load Filtered Salesforce 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.salesforce.jar
	driver_class: cdata.jdbc.salesforce.SalesforceDriver
	url: jdbc:salesforce:InitiateOAuth=GETANDREFRESH;MFACode=YourMFACode
	query: "SELECT Industry, AnnualRevenue 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 as a connector, Embulk can integrate Salesforce 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.