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

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

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

REST への JDBC 接続を設定

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

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

データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル（ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

• Document （デフォルト）：REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
• FlattenedDocuments：ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
• Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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

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

java -jar cdata.jdbc.rest.jar

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

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

jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;

Embulk で REST ののデータをロード

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 を使用してREST のデータをMySQL にロードする準備が整いました。

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

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

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

設定ファイルのサンプル（rest-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.rest.jar
	driver_class: cdata.jdbc.rest.RESTDriver
	url: jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;
	table: "people"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "people"
	mode: insert

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

embulk run rest-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.rest.jar
	driver_class: cdata.jdbc.rest.RESTDriver
	url: jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;
	query: "SELECT [ personal.name.first ], [ personal.name.last ] FROM people WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "people"
	mode: insert

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

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