How to work with Mouseflow Data in Apache Spark using SQL

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Access and process Mouseflow Data in Apache Spark using the CData JDBC Driver.

Apache Spark is a fast and general engine for large-scale data processing. When paired with the CData JDBC Driver for Mouseflow, Spark can work with live Mouseflow data. This article describes how to connect to and query Mouseflow data from a Spark shell.

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

Install the CData JDBC Driver for Mouseflow

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

Start a Spark Shell and Connect to Mouseflow Data

  1. Open a terminal and start the Spark shell with the CData JDBC Driver for Mouseflow JAR file as the jars parameter:
    $ spark-shell --jars /CData/CData JDBC Driver for Mouseflow/lib/cdata.jdbc.api.jar
    
  2. With the shell running, you can connect to Mouseflow 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 Mouseflow Profile on disk (e.g. C:\profiles\Mouseflow.apip). Next, set the ProfileSettings connection property to the connection string for Mouseflow (see below).

    Mouseflow API Profile Settings

    Retrieve your API key from API > API Key within your Mouseflow account settings. Your region (us or eu) can be determined from your account URL.

    Built-in Connection String Designer

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

    scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Mouseflow.apip;ProfileSettings='User=your_email;Password=your_api_key;Region=us';").option("dbtable","FeedbackCampaigns").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 Mouseflow data as a temporary table:

    scala> api_df.registerTable("feedbackcampaigns")
  5. Perform custom SQL queries against the Data using commands like the one below:

    scala> api_df.sqlContext.sql("SELECT WebsiteId, CampaignId FROM FeedbackCampaigns WHERE Enabled = true").collect.foreach(println)

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

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

Ready to get started?

Connect to live data from Mouseflow with the API Driver

Connect to Mouseflow