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

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

Install the CData JDBC Driver for AgileCRM

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

Start a Spark Shell and Connect to AgileCRM Data

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

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

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

   AgileCRM API Profile Settings

   Log in to AgileCRM and go to Admin Settings > Developers & API > REST API to find your API key. Your domain is the subdomain from your AgileCRM account URL.

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';").option("dbtable","Campaigns").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 AgileCRM data as a temporary table:

   scala> api_df.registerTable("campaigns")

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

   scala> api_df.sqlContext.sql("SELECT Id, Name FROM Campaigns WHERE IsDisabled = false").collect.foreach(println)

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

   

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