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

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

Install the CData JDBC Driver for Deel

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

Start a Spark Shell and Connect to Deel Data

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

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

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

   To authenticate to Deel, you can use API Key (Bearer Token) authentication.

   Using APIKey Authentication

   You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

   After creating your API Key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Deel API Key (Bearer token).

   Example APIKey connection string

   Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
   

   Built-in Connection String Designer

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

   scala> val api_df = spark.sqlContext.read.format("jdbc").option("url", "jdbc:api:Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';").option("dbtable","Invoices").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 Deel data as a temporary table:

   scala> api_df.registerTable("invoices")

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

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

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

   

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