Ready to get started?

Learn more about the CData JDBC Driver for Microsoft CDS or download a free trial:

Download Now

Connect to Microsoft CDS Data in Squirrel SQL Client

Connect to Microsoft CDS data and execute queries in the Squirrel SQL Client.

The CData JDBC Driver for Microsoft CDS enables you to execute queries to Microsoft CDS data in tools like Squirrel SQL Client. In this article, you will create a JDBC data source for Microsoft CDS data and execute queries.

Add the JDBC Driver for Microsoft CDS

Follow the steps below to add the driver JAR.

  1. In Squirrel SQL, click Windows -> View Drivers.
  2. Click the plus icon to open the Add Driver wizard.
  3. In the Name box, enter a user-friendly name for the driver; for example, CData JDBC Driver for Microsoft CDS.
  4. In the Example URL box, enter jdbc:cds:
  5. In the Extra Class Path tab, click Add.
  6. In the file explorer dialog that opens, select the JAR file for the driver, located in the lib subfolder of the installation directory.
  7. Click List Drivers to populate the Class Name menu with the class name for the driver, cdata.jdbc.cds.CDSDriver.

Define Connection Properties

Follow the steps below to save connection properties in the driver alias.

  1. Click Windows -> View Aliases.
  2. In the pane that lists the aliases, click the plus icon.
  3. In the Add Alias wizard that opens, the following fields are required for the JDBC driver:

    • Name: Enter a name for the alias; for example, CData Microsoft CDS Source.
    • Driver: Select the CData JDBC Driver for Microsoft CDS.
    • URL: Enter jdbc:cds:
    • User Name: Enter the username, which is added to the JDBC URL.
    • Password: Enter the password, which is added to the JDBC URL.
  4. If you want to define any additional properties, click Properties.
  5. In the Driver properties tab of the dialog that appears, select the Use driver properties checkbox.
  6. In the Specify column, select the checkboxes for the required connection properties.

    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.

    Below is a typical connection string:

    jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=GETANDREFRESH
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Microsoft CDS Data

After the metadata has loaded, a new tab for the Microsoft CDS data source is displayed. On the Objects subtab, you can discover schema information, such as the available tables and views.

To view table data, select the table on the Objects tab. The table data is then loaded in a grid on the Content tab.

To execute an SQL query, enter the query on the SQL tab and then click Run SQL (the runner icon). For example:

SELECT AccountId, Name FROM Accounts WHERE Name = 'MyAccount'