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

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

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

Jira Service Management への JDBC 接続を設定

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

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

Jira Service Management 接続プロパティの取得・設定方法

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

• URL（例：https://yoursitename.atlassian.net）

カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

• AuthScheme：Basic に設定。
• User：認証ユーザーのユーザー名に設定。
• Password：認証ユーザーのパスワードに設定。

API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。

• AuthScheme：APIToken に設定。
• User：認証ユーザーのユーザー名に設定。
• APIToken：作成したAPI トークンに設定。

ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0

この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

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

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

java -jar cdata.jdbc.jiraservicedesk.jar

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

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

jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;

Embulk で Jira Service Management ののデータをロード

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

Jira Service Management ののデータをロードするジョブを作成

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.jiraservicedesk.jar
	driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
	url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;
	table: "Requests"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Requests"
	mode: insert

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

embulk run jiraservicedesk-mysql.yml

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

フィルタリングした Jira Service Management ののデータをロード

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.jiraservicedesk.jar
	driver_class: cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver
	url: jdbc:jiraservicedesk:ApiKey=myApiKey;User=MyUser;
	query: "SELECT RequestId, ReporterName FROM Requests WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Requests"
	mode: insert

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

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