How to Query Microsoft Dataverse Data in MySQL Workbench

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

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

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.

Configure the SQL Gateway

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

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

Connect to Microsoft Dataverse through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Microsoft Dataverse).
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 SQL Gateway for Microsoft Dataverse).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Microsoft Dataverse data, like SELECT * FROM `CData CDS Sys`.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. Get started now with a free, 30-day trial of the CData ODBC Driver for Microsoft Dataverse and the CData SQL Gateway.