How to Query Procore Data in MySQL Workbench



Execute MySQL queries against live Procore data from MySQL Workbench.

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

Connect to Procore 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 Procore Profile on disk (e.g. C:\profiles\Procore.apip). Next, set the ProfileSettings connection property to the connection string for Procore (see below).

Procore API Profile Settings

To authenticate to Procore, and connect to your own data or to allow other users to connect to their data, you can use the OAuth standard.

First, you will need to register an OAuth application with Procore. You can do so by logging to your Developer Account and going to Create New App. Follow all necessary steps to register your app. First you will need to create a new version of Sandbox Manifest and then promote it to Production in order to get your Production Crendentials. Your Oauth application will be assigned a client id and a client secret.

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

  • AuthScheme: Set this to OAuth.
  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
  • OAuthClientId: Set this to the client_id that is specified in you app settings.
  • OAuthClientSecret: Set this to the client_secret that is specified in you app settings.
  • CallbackURL: Set this to the Redirect URI that is specified in your app settings

Configure the SQL Gateway

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

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

Connect to Procore through the SQL Gateway

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

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

With access to live Procore data from MySQL Workbench, you can easily query and update Procore, 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 Procore with the API Driver

Connect to Procore