How to work with SerpApi 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 SerpApi, Spark can work with live SerpApi data. This article describes how to connect to and query SerpApi data from a Spark shell.

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

Install the CData JDBC Driver for SerpApi

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

Start a Spark Shell and Connect to SerpApi Data

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

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

2. With the shell running, you can connect to SerpApi 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 SerpAPI Profile on disk (e.g. C:\profiles\SerpAPI.apip). Next, set the ProfileSettings connection property to the connection string for SerpAPI (see below).

   SerpAPI API Profile Settings

   SerpAPI uses API key authentication. To obtain an API key:

   1. Sign in to your SerpAPI account at https://serpapi.com
   2. Navigate to the API Key page at https://serpapi.com/manage-api-key
   3. Copy your private API key

   After obtaining your API key, set the following connection properties:

   • AuthScheme: Set this to APIKey.

   Set the following in the ProfileSettings connection property:

   • APIKey: Set this to your SerpAPI private API key.

   Built-in Connection String Designer

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

   
   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\SerpAPI.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key_here';").option("dbtable","AmazonSearch").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 SerpApi data as a temporary table:

   scala> api_df.registerTable("amazonsearch")

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

   scala> api_df.sqlContext.sql("SELECT Asin, Title FROM AmazonSearch WHERE SearchQuery = mechanical keyboard").collect.foreach(println)

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

   

Using the CData JDBC Driver for SerpApi in Apache Spark, you are able to perform fast and complex analytics on SerpApi 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.