Ready to get started?

Download a free trial of the Sugar Driver to get started:

 Download Now

Learn more:

Sugar Icon Sugar JDBC Driver

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

Connect to Sugar CRM Data in as an External Source in Dremio



Use the CData JDBC Driver to connect to Sugar CRM as an External Source in Dremio.

The CData JDBC Driver for Sugar implements JDBC Standards and allows various applications, including Dremio, to work with live Sugar CRM data. Dremio is a data lakehouse platform designed to empower self-service, interactive analytics on the data lake. With the CData JDBC Driver, you can include live Sugar CRM data as a part of your enterprise data lake. This article describes how to connect to Sugar CRM data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live Sugar CRM data in Dremio. Once you install the driver, authenticate with Sugar CRM and gain immediate access to Sugar CRM data within your data lake. By surfacing Sugar CRM data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to Sugar CRM data.

Build the ARP Connector

To use the CData JDBC Driver in Dremio, you need to build an Advanced Relation Pushdown (ARP) Connector. You can view the source code for the Connector on GitHub or download the ZIP file (GitHub.com) directly. Once you copy or extract the files, run the following command from the root directory of the connector (the directory containing the pom.xml file) to build the connector.

mvn clean install

Once the JAR file for the connector is built (in the target directory), you are ready to copy the ARP connector and JDBC Driver to your Dremio instance.

Installing the Connector and JDBC Driver

Install the ARP Connector to %DREMIO_HOME%/jars/ and the JDBC Driver for Sugar CRM to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

docker cp PATH\TO\dremio-sugarcrm-plugin-20.0.0.jar dremio_image_name:/opt/dremio/jars/

JDBC Driver for Sugar CRM

docker cp PATH\TO\cdata.jdbc.sugarcrm.jar dremio_image_name:/opt/dremio/jars/3rdparty/

Connecting to Sugar CRM

Sugar CRM will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to Sugar CRM data. The JDBC Driver has a built-in connection string designer that you can use (see below).

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Sugar CRM JDBC Driver. 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.

NOTE: To use the JDBC Driver in Dremio, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Add the Runtime Key (RTK) to the JDBC URL. You will end up with a JDBC URL similar to the following:

jdbc:sugarcrm:RTK=5246...;User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;

Access Sugar CRM as an External Source

To add Sugar CRM as an External Source, click to add a new source and select SugarCRM. Copy the JDBC URL and paste it into the New SugarCRM Source wizard.

Save the connection and you are ready to query live Sugar CRM data in Dremio, easily incorporating Sugar CRM data into your data lake.

More Information & Free Trial

Using the CData JDBC Driver for Sugar in Dremio, you can incorporate live Sugar CRM data into your data lake. Check out our CData JDBC Driver for Sugar page for more information about connecting to Sugar CRM. Download a free, 30 day trial of the CData JDBC Driver for Sugar and get started today.