Query SuiteCRM Data in DataGrip

DataGrip is a database IDE that allows SQL developers to query, create, and manage databases. When paired with the CData JDBC Driver for SuiteCRM, DataGrip can work with live SuiteCRM data. This article shows how to establish a connection to SuiteCRM data in DataGrip and use the table editor to load SuiteCRM data.

Create a New Driver Definition for SuiteCRM

The steps below describe how to create a new Data Source in DataGrip for SuiteCRM.

1. In DataGrip, click File -> New > Project and name the project
2. In the Database Explorer, click the plus icon () and select Driver.
3. In the Driver tab:
   • Set Name to a user-friendly name (e.g. "CData SuiteCRM Driver")
   • Set Driver Files to the appropriate JAR file. To add the file, click the plus (), select "Add Files," navigate to the "lib" folder in the driver's installation directory and select the JAR file (e.g. cdata.jdbc.suitecrm.jar).
   • Set Class to cdata.jdbc.suitecrm.SuiteCRM.jar
   Additionally, in the advanced tab you can change driver properties and some other settings like VM Options, VM environment, VM home path, DBMS, etc
   • For most cases, change the DBMS type to "Unknown" in Expert options to avoid native SQL Server queries (Transact-SQL), which might result in an invalid function error
4. Click "Apply" then "OK" to save the Connection

Configure a Connection to SuiteCRM

1. Once the connection is saved, click the plus (), then "Data Source" then "CData SuiteCRM Driver" to create a new SuiteCRM Data Source.
2. In the new window, configure the connection to SuiteCRM with a JDBC URL.

   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.

   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.

3. Set URL to the connection string, e.g., jdbc:suitecrm:URL=http://mySuiteCRM.com;User=myUser;Password=myPassword;
4. Click "Apply" and "OK" to save the connection string

At this point, you will see the data source in the Data Explorer.

Execute SQL Queries Against SuiteCRM

To browse through the SuiteCRM entities (available as tables) accessible through the JDBC Driver, expand the Data Source.

To execute queries, right click on any table and select "New" -> "Query Console."

In the Console, write the SQL query you wish to execute. For example: SELECT Name, Industry FROM Accounts

Download a free, 30-day trial of the CData JDBC Driver for SuiteCRM and start working with your live SuiteCRM data in DataGrip. Reach out to our Support Team if you have any questions.