Query SuiteCRM Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to SuiteCRM data as if it were a MySQL database. This article shows how to create a virtual database for SuiteCRM in Connect and work with live SuiteCRM data in MySQL Workbench.

Create a Virtual MySQL Database for SuiteCRM Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "SuiteCRM" from Available Data Sources.
3. Enter the necessary authentication properties to connect to 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.

4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to SuiteCRM from MySQL Workbench.

Query SuiteCRM from MySQL Workbench

The steps below outline connecting to the virtual SuiteCRM database in Connect from MySQL Workbench and issuing basic queries to work with live SuiteCRM data.

Connect to SuiteCRM through Connect

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData Connect).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

Query SuiteCRM Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve SuiteCRM data, like SELECT * FROM suitecrmdb.Accounts;

With access to live SuiteCRM data from MySQL Workbench, you can easily query and update SuiteCRM, just like you would a MySQL database. Request a demo of the CData Connect and start working with SuiteCRM just like a MySQL database today.