How to work with Yotpo Data in Apache Spark using SQL

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

The CData JDBC Driver offers unmatched performance for interacting with live Yotpo data due to optimized data processing built into the driver. When you issue complex SQL queries to Yotpo, the driver pushes supported SQL operations, like filters and aggregations, directly to Yotpo 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 Yotpo data using native data types.

Install the CData JDBC Driver for Yotpo

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

Start a Spark Shell and Connect to Yotpo Data

1. Open a terminal and start the Spark shell with the CData JDBC Driver for Yotpo JAR file as the jars parameter:

   
   $ spark-shell --jars /CData/CData JDBC Driver for Yotpo/lib/cdata.jdbc.api.jar
   

2. With the shell running, you can connect to Yotpo with a JDBC URL and use the SQL Context load() function to read a table.

   Start by setting the Profile connection property to the location of the Yotpo Profile on disk (e.g. C:\profiles\Yotpo.apip). Next, set the ProfileSettings connection property to the connection string for Yotpo (see below).

   Yotpo API Profile Settings

   To authenticate to Yotpo, you can use the OAuth 2.0 client credentials flow with your Yotpo AppKey and AppSecret.

   To use the Yotpo API, you need a Yotpo store account with an AppKey and AppSecret. You can find these credentials in the Yotpo dashboard under Account Settings > Store.

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to OAuthClient.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to your Yotpo AppKey.
   • OAuthClientSecret: Set this to your Yotpo AppSecret.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Yotpo 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.

   

   Configure the connection to Yotpo, using the connection string generated above.

   
   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;").option("dbtable","ProductBottomLine").option("driver","cdata.jdbc.api.APIDriver").load()
   

3. Once you connect and the data is loaded you will see the table schema displayed.

4. Register the Yotpo data as a temporary table:

   scala> api_df.registerTable("productbottomline")

5. Perform custom SQL queries against the Data using commands like the one below:

   scala> api_df.sqlContext.sql("SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = my-product-sku").collect.foreach(println)

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

   

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