ETL ツールのEmbulk を使ってConfluence のデータをDB にロードする方法

こんにちは！リードエンジニアの杉本です。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for Confluence を使って、Confluence のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。

Embulk でConfluence のデータをロード

• CData JDBC Driver for Confluence をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for Confluence 2019J\lib\cdata.jdbc.confluence.jar

• 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。

  https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

  インストール用のコマンドはこちら：

  embulk gem install embulk-input-jdbc

• 今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。

  https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

  コマンドはこちら。

  embulk gem install embulk-output-mysql
• config ファイルを作成し、Confluence -> MySQL のジョブを作成します。confluence-mysql.yml というファイル名で、以下の内容で作成しました。
in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for Confluence 2024J\lib\cdata.jdbc.confluence.jar driver_class: cdata.jdbc.confluence.ConfluenceDriver url: jdbc:confluence:User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York; table: "Pages" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Pages" mode: insert
• JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

  API Token を取得する方法

  API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

  Confluence Cloud Account への接続

  Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

  • User: Confluence サーバーに認証するユーザー名。
  • APIToken: 認証するユーザーに紐付けられたAPI Token。
  • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

  Confluence Server Instance への接続

  Server instance への接続には以下を設定します:

  • User: Confluence Instance に接続するユーザー名。
  • Password: Confluence Instance に接続するユーザーのパスワード。
  • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net
• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run confluence-mysql.yml
• 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

おわりに

CData JDBC Driver for Confluence をEmbulk で使うことで、Confluence と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。