Learn more
 

Load Highrise Data to a Database Using Embulk


Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load Highrise data to a database.

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

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

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

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

Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

See the "Getting Started" section in the help documentation for a guide to using OAuth.

Built-in Connection String Designer

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

java -jar cdata.jdbc.highrise.jar

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

Below is a typical JDBC connection string for Highrise:

jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=GETANDREFRESH

Load Highrise 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
    2. 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 Highrise data into MySQL using Embulk.

Create a Job to Load Highrise Data

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

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

Sample Config File (highrise-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.highrise.jar driver_class: cdata.jdbc.highrise.HighriseDriver url: jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=REFRESH table: "Deals" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Deals" mode: insert

After creating the file, run the Embulk job.

embulk run highrise-mysql.yml

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

Load Filtered Highrise 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.highrise.jar driver_class: cdata.jdbc.highrise.HighriseDriver url: jdbc:highrise:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost;AccountId=MyAccountId;InitiateOAuth=REFRESH query: "SELECT Name, Price FROM Deals WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Deals" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Highrise as a connector, Embulk can integrate Highrise 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.

Ready to get started?

Download a free trial of the Highrise Driver to get started:

 Download Now

Learn more:

Highrise Icon Highrise JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Highrise account data including Accounts, Deals, Emails, People, Tasks, and more!

In this article

Related articles