We are proud to share our inclusion in the 2024 Gartner Magic Quadrant for Data Integration Tools. We believe this recognition reflects the differentiated business outcomes CData delivers to our customers.
Get the Report →Load Shippo Data to a Database Using Embulk
Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load Shippo data to a database.
Embulk is an open source bulk data loader. When paired with the CData API Driver for JDBC, Embulk easily loads data from Shippo to any supported destination. In this article, we explain how to use the CData API Driver for JDBC in Embulk to load Shippo data to a MySQL dtabase.
With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live Shippo data. When you issue complex SQL queries to Shippo, the driver pushes supported SQL operations, like filters and aggregations, directly to Shippo and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).
Configure a JDBC Connection to Shippo 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 API Driver for JDBC\lib).
Embulk supports JDBC connectivity, so you can easily connect to Shippo and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Shippo.
Start by setting the Profile connection property to the location of the Shippo Profile on disk (e.g. C:\profiles\Shippo.apip). Next, set the ProfileSettings connection property to the connection string for Shippo (see below).
Shippo API Profile Settings
In order to authenticate to Shippo, you will need an API Key. You can find this API key under 'Settings' > 'API' > 'Generate Token'. After generating your key, set it to the APIKey in ProfileSettings connection property.
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Shippo JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.
java -jar cdata.jdbc.api.jar
Fill in the connection properties and copy the connection string to the clipboard.
Below is a typical JDBC connection string for Shippo:
jdbc:api:Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';
Load Shippo 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
- Install the JDBC Input Plugin in Embulk.
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc - 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-mysqlembulk gem install embulk-output-mysql
embulk gem install embulk-input-jdbc
With the input and output plugins installed, we are ready to load Shippo data into MySQL using Embulk.
Create a Job to Load Shippo Data
Start by creating a config file in Embulk, using a name like api-mysql.yml.
- For the input plugin options, use the CData API Driver for JDBC, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.api.APIDriver), and the JDBC URL from above
- For the output plugin options, use the values and credentials for the MySQL database
Sample Config File (api-mysql.yml)
in:
type: jdbc
driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.api.jar
driver_class: cdata.jdbc.api.APIDriver
url: jdbc:api:Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';
table: "Orders"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Orders"
mode: insert
After creating the file, run the Embulk job.
embulk run api-mysql.yml
After running the the Embulk job, find the Salesforce data in the MySQL table.
Load Filtered Shippo 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.api.jar
driver_class: cdata.jdbc.api.APIDriver
url: jdbc:api:Profile=C:\profiles\Shippo.apip;ProfileSettings='APIKey=my_api_key';
query: "SELECT ObjectId , OrderStatus FROM Orders WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Orders"
mode: insert
More Information & Free Trial
By using CData API Driver for JDBC as a connector, Embulk can integrate Shippo 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.