How to connect and process Gong data from Azure Databricks
Databricks is a cloud-based service that provides data processing capabilities through Apache Spark. When paired with the CData JDBC Driver, customers can use Databricks to perform data engineering and data science on live Gong data. This article explains how to host the CData JDBC Driver in Azure, as well as connect to and process live Gong data in Databricks.
With built-in optimized data processing, the CData JDBC driver offers unmatched performance for interacting with live Gong data. When you issue complex SQL queries to Gong, the driver pushes supported SQL operations, like filters and aggregations, directly to Gong and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). Its built-in dynamic metadata querying allows you to work with and analyze Gong data using native data types.
Install the CData JDBC Driver in Azure
To work with live Gong data in Databricks, install the driver through Azure Data Lake Storage (ADLS). (Please note that the method of connecting through DBFS, which previous versions of this article described, has been deprecated, but has not published an end-of-life.)
- Upload the JDBC JAR file to a blob container of your choice (i.e. "jdbcjars" container of the "databrickslibraries" storage account).
- Fetch the Account Key from the storage account by expanding "Security + networking" and clicking on "Access Keys". Show and copy whichever of the two keys you wish to use.
- Get the JDBC JAR file's URL by navigating to Containers, opening the specific container storing the JAR, and selecting the entry for the JDBC JAR file. This should open the file's details, where there should be a convenient button to copy the URL button to clipboard. This value will look similar to the below, though the "blob" component may vary depending on storage account type:
https://databrickslibraries.blob.core.windows.net/jdbcjars/cdata.jdbc.salesforce.jar
- In the Configuration tab of your Databricks cluster, click on the Edit button and expand "Advanced options". From there, add the following Spark option (derived from the JAR URL's domain name) with your copied Account key as its value and click Confirm:
spark.hadoop.fs.azure.account.key.databrickslibraries.blob.core.windows.net
- In the Libraries tab of your Databricks cluster, click on "Install new", and select the ADLS option. Specify the ABFSS URL for the driver JAR (also derived from the JAR URL's domain name), and click Install. The ABFSS URL should resemble the below:
abfss://[email protected]/cdata.jdbc.salesforce.jar
Connect to Gong from Databricks
With the JAR file installed, we are ready to work with live Gong data in Databricks. Start by creating a new notebook in your workspace. Name the workbook, make sure Python is selected as the language (which should be by default), click on Connect and under General Compute select the cluster where you installed the JDBC driver (should be selected by default).
Configure the Connection to Gong
Connect to Gong by referencing the class for the JDBC Driver and constructing a connection string to use in the JDBC URL. Additionally, you will need to set the RTK property in the JDBC URL (unless you are using a Beta driver). You can view the licensing file included in the installation for information on how to set this property.
driver = "cdata.jdbc.api.APIDriver" url = "jdbc:api:RTK=5246...;Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';"
Built-in Connection String Designer
For assistance in constructing the JDBC URL, use the connection string designer built into the Gong 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.
To authenticate to Gong, you can use API Key authentication with your Gong API Key and API Secret.
Authentication
To authenticate to Gong, you must provide your Gong API Key and API Secret, along with your tenant Domain. These credentials are combined and Base64-encoded to form the Basic authentication header used for all API requests.
Using API Key Authentication
To authenticate using an API Key, you need to obtain your API Key and API Secret from your Gong account settings.
You can then connect by setting the AuthScheme to APIKey and providing your credentials:
- AuthScheme: Set this to APIKey.
- APIKey: Set this to your Gong API Key.
- APISecret: Set this to your Gong API Secret.
- Domain: Set this to your Gong tenant domain (e.g., us-36533.api.gong.io).
Example connection string
Profile=C:\profiles\Gong.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key;APISecret=your_api_secret;Domain=your-tenant.api.gong.io';
Load Gong Data
Once the connection is configured, you can load Gong data as a dataframe using the CData JDBC Driver and the connection information.
remote_table = spark.read.format ( "jdbc" ) \ .option ( "driver" , driver) \ .option ( "url" , url) \ .option ( "dbtable" , "AnsweredScorecards") \ .load ()
Display Gong Data
Check the loaded Gong data by calling the display function.
display (remote_table.select (""))
Analyze Gong Data in Azure Databricks
If you want to process data with Databricks SparkSQL, register the loaded data as a Temp View.
remote_table.createOrReplaceTempView ( "SAMPLE_VIEW" )
The SparkSQL below retrieves the Gong data for analysis.
result = spark.sql("SELECT , FROM SAMPLE_VIEW WHERE = ''")
The data from Gong is only available in the target notebook. If you want to use it with other users, save it as a table.
remote_table.write.format ( "parquet" ) .saveAsTable ( "SAMPLE_TABLE" )
Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live Gong data in Azure Databricks. Reach out to our Support Team if you have any questions.