Access Cvent Data from MySQL in HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with the CData ODBC Driver for Cvent and SQL Gateway, HediSQL's reach extends to include access to live Cvent data. This article demonstrates how to connect to on-premise Cvent and query Cvent data in HeidiSQL.

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.

When you configure the DSN, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

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.

To connect to the SQL Gateway from HeidiSQL, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:

• The IP address or domain name of the machine hosting the SQL Gateway
• The data source name (likely CData Cvent Sys) of the MySQL service
• The port number of the MySQL service
• The credentials of a SQL Gateway user with access to the service

Configure Remote Access

If your ODBC Driver and the remoting service are installed on-premise (and not accessible from HeidiSQL), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.

Connect to Cvent in HeidiSQL

Once you have a MySQL Service configured for the CData ODBC Driver for Cvent, you are ready to connect to the data in HeidiSQL. Start by creating a new connection Session in HeidiSQL, then choose the MySQL library type.

Configure the data set using the values for the MySQL service for Cvent you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Open.

Query Cvent from HeidiSQL

1. In the database listing on the left, find your connection to Cvent configured earlier.
2. In the database listing on the left, expand the appropriate connection and to view individual tables or data objects present within Cvent.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables

With the CData ODBC Driver for Cvent and SQL Gateway, you are able to easily query data from Cvent data in HeidiSQL. If you have any questions, such as needing to access your on-premises data from HeidiSQL, let our Support Team know.