Backlog データ のPostgreSQL インターフェースを作成

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

Backlog にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for Backlog とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからBacklog にクエリを実行します。

JDBC データソースとしてBacklog データに接続する

JDBC データソースとしてBacklog に接続するには、以下が必要です。

• Driver のJAR パス：JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。

• Driver クラス

  cdata.jdbc.backlog.BacklogDriver
• JDBC URL: URL は、"jdbc:backlog:" で始まり、セミコロンで区切られた名前と値の組み合わせで任意の接続プロパティを含めることができます。

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

  API キー認証

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

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

  OAuth 認証

  ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントを参照してください。

  ビルトイン接続文字列デザイナ

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

  java -jar cdata.jdbc.backlog.jar

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

  以下は一般的なJDBC URL です。

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

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例： ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
2. ビルドするには、以下のコマンドを実行してください。 make install USE_PGXS=1

Backlog データをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってBacklog へのクエリの実行を開始します。

1. データベースにログイン
2. データベースの拡張機能をロード CREATE EXTENSION jdbc2_fdw;
3. Backlog のオブジェクトを作成 CREATE SERVER Backlog FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS ( drivername 'cdata.jdbc.backlog.BacklogDriver', url 'jdbc:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;', querytimeout '15', jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.backlog.jar');
4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成 CREATE USER MAPPING for postgres SERVER Backlog OPTIONS ( username 'admin', password 'test');
5. ローカルデータベースに外部テーブルを作成 postgres=# CREATE FOREIGN TABLE issues ( issues_id text, issues_Id text, issues_ProjectID numeric) SERVER Backlog OPTIONS ( table_name 'issues');

おわりに

このようにCData JDBC Driver for Backlog を使って簡単にBacklog データを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。