How to Query CleverPush Data in MySQL Workbench

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

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

Start by setting the Profile connection property to the location of the Cleverpush Profile on disk (e.g. C:\profiles\Cleverpush.apip). Next, set the ProfileSettings connection property to the connection string for Cleverpush (see below).

Cleverpush API Profile Settings

CleverPush uses private API keys to authenticate requests. Your API key is passed as the Authorization request header value on every API call.

You can find your private API key in the CleverPush dashboard under Settings > API. Use the private key (not the public key) for server-side access.

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

• AuthScheme: Set this to APIKey.
• APIKey: Set this to your CleverPush private API key.

Optional Connection Properties

• ChannelId: Set this to your default CleverPush channel identifier. Most tables require a channel filter. Setting this property allows queries without specifying ChannelId in every WHERE clause.

Configure the SQL Gateway

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

Query CleverPush from MySQL Workbench

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

Connect to CleverPush through the SQL Gateway

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

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

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