Learn more
 

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!

In this article

Related articles

Load SuiteCRM Data to a Database Using Embulk


Use CData JDBC drivers with the open source ETL/ELT tool Embulk to load SuiteCRM data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for SuiteCRM, Embulk easily loads data from SuiteCRM to any supported destination. In this article, we explain how to use the CData JDBC Driver for SuiteCRM in Embulk to load SuiteCRM data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live SuiteCRM data. When you issue complex SQL queries to SuiteCRM, the driver pushes supported SQL operations, like filters and aggregations, directly to SuiteCRM and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations).

Configure a JDBC Connection to SuiteCRM Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for SuiteCRM\lib).

Embulk supports JDBC connectivity, so you can easily connect to SuiteCRM and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with SuiteCRM.

The User and Password properties must be set to valid SuiteCRM user credentials. Additionally, specify the URL to the SuiteCRM application, for example http://suite.crm.com.

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.

Built-in Connection String Designer

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

Below is a typical JDBC connection string for SuiteCRM:

jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;

Load SuiteCRM Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load SuiteCRM data into MySQL using Embulk.

Create a Job to Load SuiteCRM Data

Start by creating a config file in Embulk, using a name like suitecrm-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for SuiteCRM, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.suitecrm.SuiteCRMDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (suitecrm-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.suitecrm.jar driver_class: cdata.jdbc.suitecrm.SuiteCRMDriver url: jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword; table: "Accounts" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Accounts" mode: insert

After creating the file, run the Embulk job.

embulk run suitecrm-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered SuiteCRM Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.suitecrm.jar driver_class: cdata.jdbc.suitecrm.SuiteCRMDriver url: jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword; query: "SELECT Name, Industry FROM Accounts WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Accounts" mode: insert

More Information & Free Trial

By using CData JDBC Driver for SuiteCRM as a connector, Embulk can integrate SuiteCRM data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.