Learn more
 

Ready to get started?

Download a free trial of the Microsoft Dataverse Driver to get started:

 Download Now

Learn more:

Microsoft Dataverse Icon Microsoft Dataverse JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Microsoft Dataverse.

In this article

Related articles

Load Microsoft Dataverse Data to a Database Using Embulk


Use CData JDBC Driver for Microsoft Dataverse with the open source ETL/ELT tool Embulk to load Microsoft Dataverse data to a database.

Embulk is an open source bulk data loader. When paired with the CData JDBC Driver for Microsoft Dataverse, Embulk easily loads data from Microsoft Dataverse to any supported destination. In this article, we explain how to use the CData JDBC Driver for Microsoft Dataverse in Embulk to load Microsoft Dataverse data to a MySQL dtabase.

With built-in optimized data processing, the CData JDBC Driver 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).

Configure a JDBC Connection to Microsoft Dataverse Data

Before creating a bulk load job in Embulk, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Microsoft Dataverse\lib).

Embulk supports JDBC connectivity, so you can easily connect to Microsoft Dataverse and execute SQL queries. Before creating a bulk load job, create a JDBC URL for authenticating with Microsoft Dataverse.

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.

Below is a typical JDBC connection string for Microsoft Dataverse:

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

Load Microsoft Dataverse Data in Embulk

After installing the CData JDBC Driver and creating a JDBC connection string, install the required Embulk plugins.

Install Embulk Input & Output Plugins

  1. Install the JDBC Input Plugin in Embulk.
    https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc
    2. embulk gem install embulk-input-jdbc
  2. In this article, we use MySQL as the destination database. You can also choose SQL Server, PostgreSQL, or Google BigQuery as the destination using the output Plugins.
    https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql embulk gem install embulk-output-mysql

With the input and output plugins installed, we are ready to load Microsoft Dataverse data into MySQL using Embulk.

Create a Job to Load Microsoft Dataverse Data

Start by creating a config file in Embulk, using a name like cds-mysql.yml.

  1. For the input plugin options, use the CData JDBC Driver for Microsoft Dataverse, including the path to the driver JAR file, the driver class (e.g. cdata.jdbc.cds.CDSDriver), and the JDBC URL from above
  2. For the output plugin options, use the values and credentials for the MySQL database

Sample Config File (cds-mysql.yml)

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.cds.jar driver_class: cdata.jdbc.cds.CDSDriver url: jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=REFRESH table: "Accounts" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Accounts" mode: insert

After creating the file, run the Embulk job.

embulk run cds-mysql.yml

After running the the Embulk job, find the Salesforce data in the MySQL table.

Load Filtered Microsoft Dataverse Data

In addition to loading data directly from a table, you can use a custom SQL query to have more granular control of the data loaded. You can also perform increment loads by setting a last updated column in a SQL WHERE clause in the query field.

in: type: jdbc driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.cds.jar driver_class: cdata.jdbc.cds.CDSDriver url: jdbc:cds:OrganizationUrl=https://myaccount.crm.dynamics.com/InitiateOAuth=REFRESH query: "SELECT AccountId, Name FROM Accounts WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Accounts" mode: insert

More Information & Free Trial

By using CData JDBC Driver for Microsoft Dataverse as a connector, Embulk can integrate Microsoft Dataverse data into your data load jobs. And with drivers for more than 200+ other enterprise sources, you can integrate any enterprise SaaS, big data, or NoSQL source as well. Download a 30-day free trial and get started today.