How to Query REST Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for REST to query REST data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live REST data in MySQL Workbench.

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

See the Getting Started chapter in the data provider documentation to authenticate to your data source: The data provider models REST APIs as bidirectional database tables and XML/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 and providing any authentication values, set to "XML" or "JSON" and set to more closely match the data representation to the structure of your data.

The 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 REST 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 REST 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to REST 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.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

Query REST from MySQL Workbench

The steps below outline connecting to the virtual REST database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live REST data.

Connect to REST through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for REST).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query REST Data

1. Open the connection you just created (CData SQL Gateway for REST).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve REST data, like SELECT * FROM `CData REST Sys`.people;

With access to live REST data from MySQL Workbench, you can easily work with REST, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData ODBC Driver for REST and the CData SQL Gateway.