Query Sugar CRM 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 Sugar CRM data as if it were a MySQL database. This article shows how to create a virtual database for Sugar CRM in Connect and work with live Sugar CRM data in MySQL Workbench.

Create a Virtual MySQL Database for Sugar CRM 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 "Sugar CRM" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Sugar CRM.

   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.

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 Sugar CRM from MySQL Workbench.

Query Sugar CRM from MySQL Workbench

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

Connect to Sugar CRM 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 Sugar CRM Data

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

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