Query SuiteCRM Data in MySQL Workbench

Ready to get started?

Download for a free trial:

Download Now

Learn more:

SuiteCRM ODBC Driver

The SuiteCRM ODBC Driver is a powerful tool that allows you to connect with live SuiteCRM account data, directly from any applications that support ODBC connectivity.

Access CRM data like you would a database - read, write, and update Leads, Contacts, Opportunities, Accounts, etc. through a standard ODBC Driver interface.

Execute MySQL queries against live SuiteCRM data from MySQL Workbench.

You can use the SQL Gateway from the ODBC Driver for SuiteCRM to query SuiteCRM data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live SuiteCRM data in MySQL Workbench.

Connect to SuiteCRM Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to SuiteCRM data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query SuiteCRM from MySQL Workbench

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

Connect to SuiteCRM through the SQL Gateway

  1. In MySQL Workbench, click to add a new MySQL connection.
  2. Name the connection (CData SQL Gateway for SuiteCRM).
  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 SQL Gateway for SuiteCRM).
  2. Click File -> New Query Tab.
  3. Write a SQL query to retrieve SuiteCRM data, like SELECT * FROM `CData SuiteCRM Sys`.Accounts;

With access to live SuiteCRM data from MySQL Workbench, you can easily query and update SuiteCRM, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for SuiteCRM and the CData SQL Gateway.