Embulk を使用して Microsoft Dataverse ののデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for Microsoft Dataverse と組み合わせることで、Microsoft Dataverse から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for Microsoft Dataverse をEmbulk で使用してMicrosoft Dataverse のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのMicrosoft Dataverse のデータに対して比類のないパフォーマンスを発揮します。Microsoft Dataverse に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Microsoft Dataverse にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

はじめに

---

Microsoft Dataverse への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for Microsoft Dataverse\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、Microsoft Dataverse に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、Microsoft Dataverse への認証用のJDBC URL を作成します。

ユーザー資格情報の接続プロパティを設定せずに接続できます。接続に最小限必要な接続プロパティは、以下のとおりです。

• InitiateOAuth: GETANDREFRESH に設定します。
• OrganizationUrl: 接続先の組織のURL、例えばhttps://organization.crm.dynamics.com などに設定。
• Tenant (optional): デフォルトと異なるテナントに認証したい場合は、これを設定します。これは、デフォルトのテナントに所属していない組織と連携するために必要です。

接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

組み込みの接続文字列デザイナー

JDBC URL の作成には、Microsoft Dataverse JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

java -jar cdata.jdbc.cds.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、Microsoft Dataverse への一般的なJDBC 接続文字列です。

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

Embulk で Microsoft Dataverse ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してMicrosoft Dataverse のデータをMySQL にロードする準備が整いました。

Microsoft Dataverse ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はcds-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData JDBC Driver for Microsoft Dataverse、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.cds.CDSDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（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/
	table: "Accounts"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run cds-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにMicrosoft Dataverse のデータが格納されます。

フィルタリングした Microsoft Dataverse ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

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/
	query: "SELECT AccountId, Name FROM Accounts WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Accounts"
	mode: insert

詳細情報と無料トライアル

CData JDBC Driver for Microsoft Dataverse をコネクタとして使用することで、Embulk のデータロードジョブにMicrosoft Dataverse のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。