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

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

Install the CData JDBC Driver for Webex

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

Start a Spark Shell and Connect to Webex Data

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

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

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

   To authenticate to Webex, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

   Using OAuth Authentication

   First, you will need to register an OAuth application with Webex. To do so, navigate to the Webex Developer Portal and create a new integration. Your OAuth application will be assigned a client id and a client secret.

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

   • AuthScheme: Set this to OAuth.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
   • OAuthClientId: Set this to the client_id that is specified in your app settings.
   • OAuthClientSecret: Set this to the client_secret that is specified in your app settings.
   • CallbackURL: Set this to the Redirect URI that is specified in your app settings.
   • Scope: Set this in ProfileSettings to specify the OAuth scopes requested during authorization. Multiple scopes can be space-separated (e.g. ProfileSettings='Scope=spark:all spark:kms').

   Example connection string:

   Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';
   

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Webex.apip;Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;ProfileSettings='Scope=your_scopes';").option("dbtable","AdminAuditEvents").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 Webex data as a temporary table:

   scala> api_df.registerTable("adminauditevents")

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

   scala> api_df.sqlContext.sql("SELECT ,  FROM AdminAuditEvents WHERE OrgId = org123").collect.foreach(println)

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

   

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