How to create Sugar CRM federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Sugar CRM data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Sugar CRM: After you have started the service, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with Sugar CRM data just as you would local MySQL tables.

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

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Sugar CRM 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.

Create a FEDERATED Server and Tables for Sugar CRM Data

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

Create a FEDERATED Server

The following statement will create a FEDERATED server based on the ODBC Driver for Sugar CRM. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedSugarCRM
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData SugarCRM Sys');

Create a FEDERATED Table

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Accounts). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_accounts (
  ...,
  name  TYPE(LEN),
  annualrevenue  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedSugarCRM/accounts';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

Execute Queries

You can now execute queries to the Sugar CRM FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from Sugar CRM. Refer to the following example:

SELECT 
  fed_accounts.name, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_accounts 
ON 
  local_table.foreign_name = fed_accounts.name;