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

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

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

Backlog への JDBC 接続を設定

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

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

Backlog への接続に使用できる認証方法は、API キーおよびOAuth の2つです。

API キー認証

ApiKey およびURL をログインクレデンシャルに設定します。 ApiKey を取得するには：

1. Backlog の個人設定ページを開きます。
2. 「API」セクションをクリックして、「メモ」にAPI キーについての説明を追加し、「登録」ボタンをクリックします。トークンが生成されます。
3. ApiKey にAPI キーを指定します。
4. URL はBacklog のテナントURL から取得できます。

OAuth 認証

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

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

java -jar cdata.jdbc.backlog.jar

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

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

jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.backlog.jar
	driver_class: cdata.jdbc.backlog.BacklogDriver
	url: jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;
	table: "Issues"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Issues"
	mode: insert

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

embulk run backlog-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.backlog.jar
	driver_class: cdata.jdbc.backlog.BacklogDriver
	url: jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;
	query: "SELECT Id, ProjectID FROM Issues WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Issues"
	mode: insert

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

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