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

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

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

Linear への JDBC 接続を設定

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

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

Linear への認証には、個人用 API キーまたは OAuth 2.0 を使用できます。ご自身の Linear アカウントで接続する場合は、API キーを使うのが最も手軽です。

API キーによる認証

以下の接続プロパティを設定します。

• AuthScheme：APIKey に設定します。
• APIKey：Linear の個人用 API キー。

個人用 API キーを作成するには、Linear にログインして Settings > Security & access > Personal API keys を開き、New API key を選択して作成します。キーは一度しか表示されないため、すぐにコピーしておきましょう。

OAuth による認証

OAuth を使用するには、Linear にカスタム OAuth アプリケーションを登録する必要があります（Settings > API > OAuth applications）。登録すると OAuthClientId と OAuthClientSecret が発行されます。対応しているフローは以下の 2 つです。

• Authorization code：AuthScheme を OAuth、InitiateOAuth を GETANDREFRESH に設定し、OAuthClientId、OAuthClientSecret、およびアプリケーションで定義した CallbackURL（例：http://localhost:33333）を指定します。ドライバーがブラウザで Linear を開くので、アクセスを許可してください。
• Client credentials：AuthScheme を OAuthClient に設定し、OAuthClientId と OAuthClientSecret を指定します。アプリケーション自体を認証するためブラウザ操作は不要で、マシン間（M2M）連携に適しています。

デフォルトでは、ドライバーは read,write スコープをリクエストします。アクセストークンは有効期限が切れると自動で更新されます。

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

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

java -jar cdata.jdbc.linear.jar

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

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

jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData JDBC Driver for Linear 20xx\lib\cdata.jdbc.linear.jar
	driver_class: cdata.jdbc.linear.LinearDriver
	url: jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
	table: "Team"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Team"
	mode: insert

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

embulk run linear-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData JDBC Driver for Linear 20xx\lib\cdata.jdbc.linear.jar
	driver_class: cdata.jdbc.linear.LinearDriver
	url: jdbc:linear:AuthScheme=APIKey;APIKey=myAPIKey;
	query: "SELECT id, name FROM Team WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Team"
	mode: insert

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

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