Process & Analyze Sugar CRM Data in Azure Databricks

Ready to get started?

Download for a free trial:

Download Now

Learn more:

Sugar JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Sugar account data including Leads, Contacts, Opportunities, Accounts, and more!



Host the CData JDBC Driver for Sugar CRM in Azure and use Databricks to perform data engineering and data science on live Sugar CRM data.

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 Sugar CRM data. This article walks through hosting the CData JDBC Driver in Azure, as well as connecting to and processing live Sugar CRM data in Databricks.

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

Install the CData JDBC Driver in Azure

To work with live Sugar CRM data in Databricks, install the driver on your Azure cluster.

  1. Navigate to your Databricks administration screen and select the target cluster.
  2. On the Libraries tab, click "Install New."
  3. Select "Upload" as the Library Source and "Jar" as the Library Type.
  4. Upload the JDBC JAR file (cdata.jdbc.sugarcrm.jar) from the installation location (typically C:\Program Files\CData\CData JDBC Driver for Sugar CRM\lib).

Connect to Sugar CRM from Databricks

With the JAR file installed, we are ready to work with live Sugar CRM data in Databricks. Start by creating a new notebook in your workspace. Name the notebook, select Python as the language (though Scala is available as well), and choose the cluster where you installed the JDBC driver. When the notebook launches, we can configure the connection, query Sugar CRM, and create a basic report.

Configure the Connection to Sugar CRM

Connect to Sugar CRM 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.sugarcrm.SugarCRMDriver"
url = "jdbc:sugarcrm:RTK=5246...;User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;"

Built-in Connection String Designer

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

java -jar cdata.jdbc.sugarcrm.jar

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

The User and Password properties, under the Authentication section, must be set to valid SugarCRM user credentials. This will use the default OAuth token created to allow client logins. OAuthClientId and OAuthClientSecret are required if you do not wish to use the default OAuth token.

You can generate a new OAuth consumer key and consumer secret in Admin -> OAuth Keys. Set the OAuthClientId to the OAuth consumer key. Set the OAuthClientSecret to the consumer secret.

Additionally, specify the URL to the SugarCRM account.

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in the "Caching Metadata" chapter of the help documentation.

Load Sugar CRM Data

Once the connection is configured, you can load Sugar CRM 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" , "Accounts") \
	.load ()

Display Sugar CRM Data

Check the loaded Sugar CRM data by calling the display function.

display (remote_table.select ("Name"))

Analyze Sugar CRM 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 Sugar CRM data for analysis.

% sql

SELECT Name, AnnualRevenue FROM Accounts

The data from Sugar CRM 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 JDBC Driver for Sugar CRM and start working with your live Sugar CRM data in Apache NiFi. Reach out to our Support Team if you have any questions.