How to Query GraphQL Data in MySQL Workbench

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

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

You must specify the URL of the GraphQL service. The driver supports two types of authentication:

• Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
• Take a look at the OAuth section in the Help documentation for detailed instructions.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to GraphQL 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 GraphQL from MySQL Workbench

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

Connect to GraphQL through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for GraphQL).
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 GraphQL Data

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

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