Learn more
 

Ready to get started?

Download a free trial of the Adobe Commerce Driver to get started:

 Download Now

Learn more:

Adobe Commerce Icon Adobe Commerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Adobe Commerce including Customers, Inventory, Products, Orders, and more!

In this article

Related articles

Load Adobe Commerce Data to a Database Using Embulk


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

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

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

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

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

Adobe Commerce uses the OAuth 1 authentication standard. To connect to the Adobe Commerce REST API, you will need to obtain values for the OAuthClientId, OAuthClientSecret, and CallbackURL connection properties by registering an app with your Adobe Commerce system. See the "Getting Started" section in the help documentation for a guide to obtaining the OAuth values and connecting.

You will also need to provide the URL to your Adobe Commerce system. The URL depends on whether you are using the Adobe Commerce REST API as a customer or administrator.

  • Customer: To use Adobe Commerce as a customer, make sure you have created a customer account in the Adobe Commerce homepage. To do so, click Account -> Register. You can then set the URL connection property to the endpoint of your Adobe Commerce system.

  • Administrator: To access Adobe Commerce as an administrator, set CustomAdminPath instead. This value can be obtained in the Advanced settings in the Admin menu, which can be accessed by selecting System -> Configuration -> Advanced -> Admin -> Admin Base URL.

    If the Use Custom Admin Path setting on this page is set to YES, the value is inside the Custom Admin Path text box; otherwise, set the CustomAdminPath connection property to the default value, which is "admin".

Built-in Connection String Designer

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

java -jar cdata.jdbc.adobe commerce.jar

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

Below is a typical JDBC connection string for Adobe Commerce:

jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=GETANDREFRESH

Load Adobe Commerce 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 Adobe Commerce data into MySQL using Embulk.

Create a Job to Load Adobe Commerce Data

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

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

Sample Config File (adobe commerce-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.adobe commerce.jar driver_class: cdata.jdbc.adobe commerce.Adobe CommerceDriver url: jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=REFRESH table: "Products" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Products" mode: insert

After creating the file, run the Embulk job.

embulk run adobe commerce-mysql.yml

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

Load Filtered Adobe Commerce 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.adobe commerce.jar driver_class: cdata.jdbc.adobe commerce.Adobe CommerceDriver url: jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;InitiateOAuth=REFRESH query: "SELECT Name, Price FROM Products WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Products" mode: insert

More Information & Free Trial

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