Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Connect to SuiteCRM Data as a Federated Tables in MySQL

Use the CData Cloud Hub to set up federated tables for SuiteCRM data in MySQL .

You can use the CData Cloud Hub to set up federated tables in MySQL for SuiteCRM data. The Cloud Hub provides a MySQL interface for SuiteCRM: After configuring a virtual MySQL database for SuiteCRM, you can create a server and tables using the FEDERATED Storage Engine in MySQL. You can then work with SuiteCRM data just as you would local MySQL tables.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for SuiteCRM, allowing you to easily query live SuiteCRM data alongside existing MySQL data — all without replicating the data. Using optimized data processing out of the box, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to SuiteCRM, leveraging server-side processing to quickly return SuiteCRM data.

Create a Virtual MySQL Database for SuiteCRM Data

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

  1. Login to Cloud Hub and click Databases.
  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 Test Database.
  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 data from any MySQL client.

Create a FEDERATED Server and Tables for SuiteCRM 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 Cloud Hub. Note that the username and password of the FEDERATED server must match a user account you defined on the Cloud Hub.

CREATE SERVER fedSuiteCRM
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'cloud_hub_user', PASSWORD 'cloud_hub_passwd', HOST 'myinstance.cdatacloud.net', PORT 3306, DATABASE 'suitecrmdb');

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),
  industry  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=utf8
CONNECTION='fedSuiteCRM/Accounts';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the Cloud Hub using any MySQL client and run SHOW COLUMNS FROM Accounts to get the table schema.

Execute Queries

You can now execute queries to the SuiteCRM 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 SuiteCRM. 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;