Load X-Cart Data to a Database Using Embulk

Ready to get started?

Download for a free trial:

Download Now

Learn more:

X-Cart JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with X-Cart.



Use CData JDBC Driver for X-Cart with the open source ETL/ELT tool Embulk to load X-Cart data to a database.

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

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

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

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

An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

  • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
  • Search for REST API Module. Install the Module.
  • After the module has been installed, you need to set it up.
    • Go to the Settings section for the REST API Module.
    • On the settings page specify the API Key (only read)
  • Set the ApiKey and Url to the connection property to connect to data.

Built-in Connection String Designer

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

java -jar cdata.jdbc.xcart.jar

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

Below is a typical JDBC connection string for X-Cart:

jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey;

Load X-Cart 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
  3. 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 X-Cart data into MySQL using Embulk.

Create a Job to Load X-Cart Data

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

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

Sample Config File (xcart-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for X-Cart 20xx\lib\cdata.jdbc.xcart.jar driver_class: cdata.jdbc.xcart.XCartDriver url: jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey; table: "PROFILES" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "PROFILES" mode: insert

After creating the file, run the Embulk job.

embulk run xcart-mysql.yml

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

Load Filtered X-Cart 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\CData JDBC Driver for X-Cart 20xx\lib\cdata.jdbc.xcart.jar driver_class: cdata.jdbc.xcart.XCartDriver url: jdbc:xcart:Url=https://example.com/shop;ApiKey=MyApiKey; query: "SELECT ProfileId, FirstName FROM PROFILES WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "PROFILES" mode: insert

More Information & Free Trial

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