DBeaver からBacklog データに連携

CData JDBC Driver for Backlog は、IDE のウィザードからBI ツールまで、サードパーティーツールからBacklog データの読み書きを可能にするJDBC 標準を実装しています。本記事では、DBeaver のウィザードを使ってBacklog データに接続し、DBeaver のGUI でデータを参照する方法を紹介します。

Backlog データのJDBC データソースを作成する

以下の手順で、DBeaver にドライバーのJAR ファイルをロードします。

1. DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
2. 「ドライバ名」ボックスに、ドライバーの分かりやすい名称を入力します。
3. .jar ファイルを追加するために、「ファイルを追加」をクリックします。
4. 表示されるダイアログで、インストールディレクトリのlib フォルダにあるcdata.jdbc.backlog.jar ファイルを選択します。
5. 「クラスを見つける」ボタンをクリックし、検索結果から「Backlog ドライバクラス」を選択します。これにより、フォーム上部にある「クラス名」フィールドが自動的に入力されます。ドライバーのクラス名はcdata.jdbc.backlog.BacklogDriver です。
6. 「URL テンプレート」フィールドにjdbc:backlog: を追加します。

Backlog データへの接続を作成する

以下の手順で、認証情報およびその他の必要な接続プロパティを追加します。

1. 「データベース」メニューから、「新しい接続」をクリックします。
2. 表示される「新しい接続を作成する」ウィザードで、ドライバーを選択します。
3. ウィザードで「次へ」をクリックし、表示されたページで「ドライバのプロパティ」タブをクリックします。

4. 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:backlog:ApiKey=YOUR_API_KEY;Url=https://yourURL.backlog.com;

Backlog データにクエリを実行

これで、公開済みテーブルのデータにクエリを実行できるようになりました。「テーブル」を右クリックし、「テーブルの編集」をクリックします。「データ」タブでデータを確認できます。