Query Microsoft Dataverse 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 Microsoft Dataverse data as if it were a MySQL database. This article shows how to create a virtual database for Microsoft Dataverse in Connect and work with live Microsoft Dataverse data in MySQL Workbench.

Create a Virtual MySQL Database for Microsoft Dataverse 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 "Microsoft Dataverse" from Available Data Sources.
3. Enter the necessary authentication properties to connect to Microsoft Dataverse.

   You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
   • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

   When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

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 Microsoft Dataverse from MySQL Workbench.

Query Microsoft Dataverse from MySQL Workbench

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

Connect to Microsoft Dataverse 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 Microsoft Dataverse Data

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

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