Ready to get started?

Learn more about the CData ODBC Driver for JSON or download a free trial:

Download Now

Access JSON Services from MySQL in Amazon QuickSight

Connect to JSON and build visualizations of JSON services using a MySQL Connection in Amazon QuickSight.

Amazon QuickSight gives you a way to quickly build visualizations, perform analytics, and get insights from AWS data sources, uploaded files, and other databases in the cloud. When paired with the CData SQL Gateway, you get the same functionality with access to 200+ Big Data, NoSQL, and SaaS sources, both on-premises and in the cloud. In this article, we use the SQL Gateway with the CData ODBC Driver for JSON to access JSON services through a MySQL connection in Amazon QuickSight, either in real time using direct queries, or by importing the data into SPICE.

Connect to JSON Services

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.

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models JSON APIs as bidirectional database tables and JSON files as read-only views (local files, files stored on popular cloud services, and FTP servers). The major authentication schemes are supported, including HTTP Basic, Digest, NTLM, OAuth, and FTP. See the Getting Started chapter in the data provider documentation for authentication guides.

After setting the URI and providing any authentication values, set DataModel to more closely match the data representation to the structure of your data.

The DataModel property is the controlling property over how your data is represented into tables and toggles the following basic configurations.

  • Document (default): Model a top-level, document view of your JSON data. The data provider returns nested elements as aggregates of data.
  • FlattenedDocuments: Implicitly join nested documents and their parents into a single table.
  • Relational: Return individual, related tables from hierarchical data. The tables contain a primary key and a foreign key that links to the parent document.

See the Modeling JSON Data chapter for more information on configuring the relational representation. You will also find the sample data used in the following examples. The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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 JSON services 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 QuickSight, 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 JSON Sys) of the MySQL service
  • The port number of the MySQL service
  • The credentials of a SQL Gateway user with access to the service

Connect to JSON in QuickSight

Once you have a MySQL Service configured for the JSON ODBC Driver, you are ready to connect to the data in QuickSight. Start by logging in to your QuickSight console. From there, click Manage Data, then click New Data Set and choose MySQL as the data source.


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


Visualize JSON Services in QuickSight

For this article, we will use a custom SQL query for our data visualization. To do so, click Edit/Preview Data and in the resulting Data Prep screen follow the steps below:

  1. Name your data set (for example, people).
  2. If you wish to import your data into QuickSight SPICE, click the SPICE option, otherwise QuickSight will query the data directly.
  3. Under the Tables menu, click Switch to Custom SQL Tool.
    • Give your SQL query a name.
    • Enter your custom SQL query. For example:
      SELECT [ personal.name.first ], [ personal.name.last ] FROM people
    • Click Finish.
  4. Click Save & Visualize.


After you have saved the data set, you can configure the visualization. Select the columns you wish to visualize and choose a visual type. Your visualization can be customized, from its name to the way that data is aggregated.


With the CData ODBC Driver for JSON and SQL Gateway, you are able to easily build data visualizations and perform analytics on JSON services in Amazon QuickSight. If you have any questions, such as needing to access your on-premises data from AWS QuickSight, let our Support Team know.