How to create Freshservice federated tables in MySQL

You can use the SQL Gateway to configure a MySQL remoting service and set up federated tables for Freshservice data. The service is a daemon process that provides a MySQL interface to the CData ODBC Driver for Freshservice: 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 Freshservice data just as you would local MySQL tables.

Connect to Freshservice 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.

Start by setting the Profile connection property to the location of the Freshservice Profile on disk (e.g. C:\profiles\Freshservice.apip). Next, set the ProfileSettings connection property to the connection string for Freshservice (see below).

Freshservice API Profile Settings

Obtain your API Key from Profile Settings in the top-right corner of Freshservice. Your Domain is the subdomain from your account URL.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Freshservice 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 Freshservice 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 Freshservice. 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 fedAPI
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData API 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 (AgentGroups). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_agentgroups (
  ...,
  id  TYPE(LEN),
  name  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAPI/agentgroups';

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 Freshservice 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 Freshservice. Refer to the following example:

SELECT 
  fed_agentgroups.id, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_agentgroups 
ON 
  local_table.foreign_id = fed_agentgroups.id;