How to connect to Microsoft Dataverse Data from IntelliJ

The CData JDBC Driver for Microsoft Dataverse enables you to access Microsoft Dataverse as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Microsoft Dataverse data in IntelliJ.

Create a JBDC Data Source for Microsoft Dataverse

Follow the steps below to add the driver JAR and define connection properties required to connect to Microsoft Dataverse data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.cds.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.cds.CDSDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:cds: and includes connection properties separated with semicolons.

     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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Microsoft Dataverse JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     java -jar cdata.jdbc.cds.jar

     Fill in the connection properties and copy the connection string to the clipboard.

     A typical JDBC URL is the following:

     jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH

Edit and Save Microsoft Dataverse Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor. You can also modify records in the Table Editor.