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

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

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

Kintone への JDBC 接続を設定

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

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

Kintone 接続プロパティの設定方法

それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。

• URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
• User：アカウントのユーザー名
• Password：アカウントのパスワード
• AuthScheme：「Password」を指定

パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。

Basic 認証の設定

続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。

• BasicAuthUser：Basic 認証のユーザー名
• BasicAuthPassword：Basic 認証のパスワード

クライアント証明書認証の設定

Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。

• SSLClientCert：クライアント証明書のパス
• SSLClientCertType：証明書の種類
• SSLClientCertSubject：証明書のサブジェクト
• SSLClientCertPassword：証明書のパスワード

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

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

java -jar cdata.jdbc.kintone.jar

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

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

jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.kintone.jar
	driver_class: cdata.jdbc.kintone.KintoneDriver
	url: jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;
	table: "Apps"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Apps"
	mode: insert

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

embulk run kintone-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.kintone.jar
	driver_class: cdata.jdbc.kintone.KintoneDriver
	url: jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;
	query: "SELECT Name, Description FROM Apps WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Apps"
	mode: insert

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

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