Load OData Services to a Database Using Embulk

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

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live OData services. When you issue complex SQL queries to OData, the driver pushes supported SQL operations, like filters and aggregations, directly to OData 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 OData Services

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 OData\lib).

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

The User and Password properties, under the Authentication section, must be set to valid OData user credentials. In addition, specify a URL to a valid OData server organization root or OData services file.

Built-in Connection String Designer

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

java -jar cdata.jdbc.odata.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 OData:

jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;

Load OData Services 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 OData services into MySQL using Embulk.

Create a Job to Load OData Services

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

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

Sample Config File (odata-mysql.yml)

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.odata.jar
	driver_class: cdata.jdbc.odata.ODataDriver
	url: jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;
	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 odata-mysql.yml

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

Load Filtered OData Services

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.odata.jar
	driver_class: cdata.jdbc.odata.ODataDriver
	url: jdbc:odata:URL=http://services.odata.org/V4/Northwind/Northwind.svc;UseIdUrl=True;OData Version=4.0;Data Format=ATOM;
	query: "SELECT OrderName, Freight 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 JDBC Driver for OData as a connector, Embulk can integrate OData services 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.