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

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

Install the CData JDBC Driver for Anaplan

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

Start a Spark Shell and Connect to Anaplan Data

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

   $ spark-shell --jars /CData/CData JDBC Driver for Anaplan/lib/cdata.jdbc.anaplan.jar
   

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

   Authenticating to Anaplan

   The driver supports authenticating with Basic, Certificate, or OAuth. In every case, set Region to the region where your Anaplan account data is hosted (e.g., US1, which is the default).

   Using Basic Authentication

   Set AuthScheme to Basic, then supply your Anaplan User and Password. If your workspace uses single sign-on (SSO), you must be assigned as an Exception User to use Basic authentication.

   Using Certificate Authentication

   Set AuthScheme to Certificate, then supply the Certificate, CertificateType, and PrivateKey properties (and the matching CertificatePassword / PrivateKeyPassword if either is encrypted). The certificate must be a CA-issued X.509 certificate registered with your Anaplan tenant administrator.

   Using OAuth Authentication

   Register a custom OAuth application in Anaplan, then set the following properties:

   • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
   • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.
   • CallbackURL: The redirect URI defined when you registered your application.
   • InitiateOAuth: Set to GETANDREFRESH to have the driver manage the OAuth token exchange and refresh automatically.

   See the Getting Started chapter of the help documentation for a guide to creating a custom OAuth app and using OAuth.

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Anaplan JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.anaplan.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

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

   scala> val anaplan_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:anaplan:OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;").option("dbtable","Sales").option("driver","cdata.jdbc.anaplan.AnaplanDriver").load()
   

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

4. Register the Anaplan data as a temporary table:

   scala> anaplan_df.registerTable("sales")

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

   scala> anaplan_df.sqlContext.sql("SELECT Region, Product FROM Sales WHERE Value = 100").collect.foreach(println)

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

   

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