How to Query Placid Data in MySQL Workbench

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

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

Placid uses API Key authentication to control access to the API. API tokens are project-specific and can be obtained from your project settings on placid.app.

Using API Key Authentication

To obtain your API key, log in to placid.app, navigate to your project, open the project settings, and generate an API token from the API section. Note that each API token is scoped to a specific project.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your Placid project API token.

Example connection string:

Profile=C:\profiles\Placid.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_project_api_token';

Configure the SQL Gateway

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

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

Connect to Placid through the SQL Gateway

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

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

With access to live Placid data from MySQL Workbench, you can easily work with Placid, 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.