Query Highrise Data in MySQL Workbench

MySQL Workbench allows users to administer MySQL environments and gain better visibility into databases. When paired with CData Connect (on-premise or Connect Server), you get live access to Highrise data as if it were a MySQL database. This article shows how to create a virtual database for Highrise in Connect and work with live Highrise data in MySQL Workbench.

Create a Virtual MySQL Database for Highrise Data

CData Connect uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

1. Login to Connect and click Connections.
2. Select "Highrise" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Highrise.

   Highrise uses the OAuth authentication standard. To authenticate to Highrise, you will need to obtain the OAuthClientId, OAuthClientSecret, and CallbackURL by registering an app with Highrise. You will also need to set the AccountId to connect to data.

   See the "Getting Started" section in the help documentation for a guide to using OAuth.

4. Click Save Changes
5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to Highrise from MySQL Workbench.

Query Highrise from MySQL Workbench

The steps below outline connecting to the virtual Highrise database in Connect from MySQL Workbench and issuing basic queries to work with live Highrise data.

Connect to Highrise through Connect

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

Query Highrise Data

1. Open the connection you just created (CData Connect).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Highrise data, like SELECT * FROM highrisedb.Deals;

With access to live Highrise data from MySQL Workbench, you can easily query and update Highrise, just like you would a MySQL database. Request a demo of the CData Connect and start working with Highrise just like a MySQL database today.