VOOZH about

URL: https://www.cdata.com/kb/tech/dataverse-jdbc-coginiti-pro.rst

⇱ Access Live Microsoft Dataverse Data in Coginiti Pro

Access Live Microsoft Dataverse Data in Coginiti Pro

👁 Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
Connect to and query live Microsoft Dataverse data from the GUI in the Coginiti Pro: SQL Analytics Tool.

Coginiti Pro is a single tool for all your SQL data and analytics needs, designed specifically for data engineers, analysts, and data scientists. When paired with the CData JDBC Driver for Microsoft Dataverse, Coginiti Pro can access and query live Microsoft Dataverse data. This article describes how to connect to and query Microsoft Dataverse data from Coginiti Pro.

With built-in optimized data processing, the CData JDBC Driver for Microsoft Dataverse offers unmatched performance for interacting with live Microsoft Dataverse data. When you issue complex SQL queries to Microsoft Dataverse, the driver pushes supported SQL operations, like filters and aggregations, directly to Microsoft Dataverse and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze Microsoft Dataverse data using native data types.

About Microsoft Dataverse Data Integration

CData provides the easiest way to access and integrate live data from Microsoft Dataverse (formerly the Common Data Service). Customers use CData connectivity to:

  • Access both Dataverse Entities and Dataverse system tables to work with exactly the data they need.
  • Authenticate securely with Microsoft Dataverse 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 Microsoft Dataverse entities - listing, creating, and removing associations between entities.

CData customers use our Dataverse 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 Dataverse data from their preferred data tools inside the Microsoft ecosystem (Power BI, Excel, etc.) or with external tools (Tableau, Looker, etc.).


Getting Started


Gather Connection Properties and Build a Connection String

Download the CData JDBC Driver for Microsoft Dataverse installer, unzip the package, and run the JAR file to install the driver. Then gather 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.

NOTE: To use the JDBC driver in Coginiti Pro, you may need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

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

java -jar cdata.jdbc.cds.jar
👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

Fill in the connection properties (including the RTK) and copy the connection string to the clipboard.

Create a JDBC Data Source for Microsoft Dataverse Data

  1. Open Coginiti Pro and in the File menu, select "Edit Drivers."
  2. In the newly opened wizard, click "Add" and select "Generic." 👁 Adding a Generic JDBC Driver.

  3. In the "JDBC Drivers" wizard, set the driver properties (below) and click "Create Driver."

    • Set JDBC Driver Name to a useful name, like CData JDBC Driver for Microsoft Dataverse.
    • Click "Add Files" to add the JAR file from the "lib" folder in the installation directory (e.g. cdata.jdbc.cds.jar)
    • Select the Class Name: cdata.jdbc.cds.CDSDriver.
    👁 Creating a new Generic data source (Salesforce is shown).

Create a Connection using the CData JDBC Driver for Microsoft Dataverse

  1. In the File menu, click "Edit Connections."
  2. In the newly opened wizard, click "Add" and select "Generic." 👁 Adding a Generic JDBC Connection.
  3. In the "Connections" wizard, set the connection properties.
    • Set Connection name to an identifying name.
    • Set Database JDBC driver to the Driver you configured earlier.
    • Set JDBC URL to the JDBC URL configured using the built-in connection string designer (e.g. jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/;InitiateOAuth=GETANDREFRESH;
    👁 Creating a connection (Salesforce is shown).
  4. Click "Test" to ensure the connection is configured properly. Click "Save."

Query Microsoft Dataverse Using SQL

  1. Open the Connections tab by clicking on database icon: .
  2. Click the plus sign () to add a new query tab.

  3. Once the query console is open, write the SQL script you wish to execute and click "Run at Cursor".

    NOTE: You can use the explorer on the left to determine table/view names and column names.

    Using the explorer

    1. In the "Select connection" field, select the connection you wish to query.
    2. Expand your newly created connection, expand the "CData" catalog, and expand the Microsoft Dataverse catalog.
    3. Expand "Tables" or "Views" to find the entity you wish to query.
    4. Expand your selected entity to explore the fields (columns).
    👁 Querying data (Salesforce is shown).

Free Trial & More Information

Download a free, 30-day trial of the CData JDBC Driver for Microsoft Dataverse and start working with your live Microsoft Dataverse data in Coginiti Pro. Reach out to our Support Team if you have any questions.