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

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

Install the CData JDBC Driver for Auth0

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

Start a Spark Shell and Connect to Auth0 Data

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

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

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

   Auth0 API Profile Settings

   Create a Machine to Machine application in your Auth0 Dashboard under Applications, then authorize it for the Auth0 Management API with the required scopes.

   Built-in Connection String Designer

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

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

   scala> api_df.registerTable("actionbindings")

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

   scala> api_df.sqlContext.sql("SELECT Id, TriggerId FROM ActionBindings WHERE DisplayName = my-action-binding").collect.foreach(println)

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

   

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