How to Query Simplesat Data in MySQL Workbench

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Execute MySQL queries against live Simplesat data from MySQL Workbench.

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

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

Using API Key Authentication

Simplesat uses API Key authentication. To obtain your API key, log in to your Simplesat account and navigate to Workspace Settings > API. Copy the API key value for use in the connection string.

After setting the following connection properties, you are ready to connect:

  • AuthScheme: Set this to APIKey.
  • APIKey: Set this to your Simplesat API key obtained from workspace settings.

Configure the SQL Gateway

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

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

Connect to Simplesat through the SQL Gateway

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

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

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

Ready to get started?

Connect to live data from Simplesat with the API Driver

Connect to Simplesat