VOOZH about

URL: https://www.cdata.com/kb/tech/dynamics365-jdbc-squirrel-sql.rst

⇱ How to connect to Dynamics 365 Data with Squirrel SQL client

How to connect to Dynamics 365 Data with Squirrel SQL client

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Connect to Dynamics 365 data and execute queries in the Squirrel SQL Client.

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

About Dynamics 365 Data Integration

CData simplifies access and integration of live Microsoft Dynamics 365 data. Our customers leverage CData connectivity to:

  • Read and write data in the full Dynamics 365 ecosystem: Sales, Customer Service, Finance & Operations, Marketing, and more.
  • Extend the native features of Dynamics CRM with customizable caching and intelligent query aggregation and separation.
  • Authenticate securely with Dynamics 365 in a variety of ways, including Azure Active Directory, Azure Managed Service Identity credentials, and Azure Service Principal using either a client secret or a certificate.
  • Use SQL stored procedures to manage their Dynamics 365 entities - listing, creating, and removing associations between entities.

CData customers use our Dynamics 365 connectivity solutions for a variety of reasons, whether they're looking to replicate their data into a data warehouse (alongside other data sources) or analyze live Dynamics 365 data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Add the JDBC Driver for Dynamics 365

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 Dynamics 365.
  4. In the Example URL box, enter jdbc:dynamics365:
  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.dynamics365.Dynamics365Driver.
👁 The definition for the JDBC data source. (Salesforce is shown.)

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 Dynamics 365 Source.
    • Driver: Select the CData JDBC Driver for Dynamics 365.
    • URL: Enter jdbc:dynamics365:
    👁 The alias definition, containing the connection parameters. (Salesforce is shown.)
  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.

    Edition and OrganizationUrl are required connection properties. The Dynamics 365 connector supports connecting to the following editions: CustomerService, FieldService, FinOpsOnline, FinOpsOnPremise, HumanResources, Marketing, ProjectOperations and Sales.

    For Dynamics 365 Business Central, use the separate Dynamics 365 Business Central driver.

    OrganizationUrl is the URL to your Dynamics 365 organization. For instance, https://orgcb42e1d0.crm.dynamics.com

    Below is a typical connection string:

    jdbc:dynamics365:OrganizationUrl=https://myaccount.operations.dynamics.com/;Edition=Sales;InitiateOAuth=GETANDREFRESH;
    👁 Connection properties automatically detected by Squirrel SQL. (Salesforce is shown.)
  7. In the dialog that appears after you click OK, click connect to test the connection.

Discover Schemas and Query Dynamics 365 Data

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

👁 Column metadata for a table. (Salesforce is shown.)

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

👁 Tables can be edited on the Content tab. (Salesforce is shown.)

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

SELECT GoalHeadingId, Name FROM GoalHeadings WHERE Name = 'MyAccount'
👁 A query and the results. (Salesforce is shown.)