Ready to get started?

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

 Download Now

Learn more:

SuiteCRM Icon SuiteCRM JDBC Driver

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

Connect to SuiteCRM Data in as an External Source in Dremio

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

The CData JDBC Driver for SuiteCRM implements JDBC Standards and allows various applications, including Dremio, to work with live SuiteCRM 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 SuiteCRM data as a part of your enterprise data lake. This article describes how to connect to SuiteCRM data from Dremio as an External Source.

The CData JDBC Driver enables high-speed access to live SuiteCRM data in Dremio. Once you install the driver, authenticate with SuiteCRM and gain immediate access to SuiteCRM data within your data lake. By surfacing SuiteCRM data using native data types and handling complex filters, aggregations, & other operations automatically, the CData JDBC Driver grants seamless access to SuiteCRM 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 ( 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 SuiteCRM to %DREMIO_HOME%/jars/3rdparty. You can use commands similar to the following:

ARP Connector

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

JDBC Driver for SuiteCRM

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

Connecting to SuiteCRM

SuiteCRM will now appear as an External Source option in Dremio. The ARP Connector built uses a JDBC URL to connect to SuiteCRM 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 SuiteCRM JDBC Driver. Double-click the JAR file or execute the jar file from the command line.

java -jar cdata.jdbc.suitecrm.jar

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

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example

Note that retrieving SuiteCRM metadata can be expensive. It is advised that you store the metadata locally as described in the Caching Metadata section of the data provider 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:


Access SuiteCRM as an External Source

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

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

More Information & Free Trial

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