Query Sugar CRM 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 Sugar, DataGrip can work with live Sugar CRM data. This article shows how to establish a connection to Sugar CRM data in DataGrip and use the table editor to load Sugar CRM data.

Create a New Driver Definition for Sugar CRM

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

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 Sugar CRM 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.sugarcrm.jar).
   • Set Class to cdata.jdbc.sugarcrm.SugarCRM.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 Sugar CRM

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

   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.

3. Set URL to the connection string, e.g., jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;
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 Sugar CRM

To browse through the Sugar CRM 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, AnnualRevenue FROM Accounts

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