How to create Cvent federated tables in MySQL

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

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

Before you can authenticate to Cvent, you must create a workspace and an OAuth application.

Creating a Workspace

To create a workspace:

1. Sign into Cvent and navigate to App Switcher (the blue button in the upper right corner of the page) >> Admin.
2. In the Admin menu, navigate to Integrations >> REST API.
3. A new tab launches for Developer Management. Click on Manage API Access in the new tab.
4. Create a Workspace and name it. Select the scopes you would like your developers to have access to. Scopes control what data domains the developer can access.
   • Choose All to allow developers to choose any scope, and any future scopes added to the REST API.
   • Choose Custom to limit the scopes developers can choose for their OAuth apps to selected scopes. To access all tables exposed by the driver, you need to set the following scopes:

     event/attendees:read	event/attendees:write	event/contacts:read
     event/contacts:write	event/custom-fields:read	event/custom-fields:write
     event/events:read	event/events:write	event/sessions:delete
     event/sessions:read	event/sessions:write	event/speakers:delete
     event/speakers:read	event/speakers:write	budget/budget-items:read
     budget/budget-items:write	exhibitor/exhibitors:read	exhibitor/exhibitors:write
     survey/surveys:read	survey/surveys:write

Creating an OAuth Application

After you have set up a Workspace and invited them, developers can sign up and create a custom OAuth app. See the Creating a Custom OAuth Application section in the Help documentation for more information.

Connecting to Cvent

After creating an OAuth application, set the following connection properties to connect to Cvent:

• InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
• OAuthClientId: The Client ID associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.
• OAuthClientSecret: The Client secret associated with the OAuth application. You can find this on the Applications page in the Cvent Developer Portal.

Configure the SQL Gateway

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

CREATE TABLE fed_events (
  ...,
  id  TYPE(LEN),
  title  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedCvent/events';

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

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