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!

How to work with Adobe Commerce Data in Apache Spark using SQL



Access and process Adobe Commerce Data in Apache Spark using the CData JDBC Driver.

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for Adobe Commerce, Spark can work with live Adobe Commerce data. This article describes how to connect to and query Adobe Commerce data from a Spark shell.

The CData JDBC Driver offers unmatched performance for interacting with live Adobe Commerce data due to optimized data processing built into the driver. 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 (often SQL functions and JOIN operations) client-side. With built-in dynamic metadata querying, you can work with and analyze Adobe Commerce data using native data types.

Install the CData JDBC Driver for Adobe Commerce

Download the CData JDBC Driver for Adobe Commerce installer, unzip the package, and run the JAR file to install the driver.

Start a Spark Shell and Connect to Adobe Commerce Data

  1. Open a terminal and start the Spark shell with the CData JDBC Driver for Adobe Commerce JAR file as the jars parameter: $ spark-shell --jars /CData/CData JDBC Driver for Adobe Commerce/lib/cdata.jdbc.adobe commerce.jar
  2. With the shell running, you can connect to Adobe Commerce with a JDBC URL and use the SQL Context load() function to read a table.

    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.

    Configure the connection to Adobe Commerce, using the connection string generated above.

    scala> val adobe commerce_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:adobe commerce:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://myAdobe Commercehost.com;").option("dbtable","Products").option("driver","cdata.jdbc.adobe commerce.Adobe CommerceDriver").load()
  3. Once you connect and the data is loaded you will see the table schema displayed.
  4. Register the Adobe Commerce data as a temporary table:

    scala> adobe commerce_df.registerTable("products")
  5. Perform custom SQL queries against the Data using commands like the one below:

    scala> adobe commerce_df.sqlContext.sql("SELECT Name, Price FROM Products WHERE Style = High Tech").collect.foreach(println)

    You will see the results displayed in the console, similar to the following:

Using the CData JDBC Driver for Adobe Commerce in Apache Spark, you are able to perform fast and complex analytics on Adobe Commerce data, combining the power and utility of Spark with your data. Download a free, 30 day trial of any of the 200+ CData JDBC Drivers and get started today.