DBeaver からBitbucket のデータに連携して可視化する方法とは？

クエリブラウザなどのDBeaver のビジュアルツールを使ってBitbucket のデータを管理する方法を解説します。

加藤龍彦
デジタルマーケティング
最終更新日：2024-03-08

この記事で実現できるBitbucket 連携のシナリオ

CData

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

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

CData JDBC ドライバとは？

CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。

Bitbucket をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
DBeaver を含む多様なアプリケーション、ツールにBitbucket のデータを連携
ノーコードでの手軽な接続設定
標準 SQL での柔軟なデータ読み込み・書き込み

CData JDBC ドライバでは、1.データソースとしてBitbucket の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData JDBC ドライバのインストールとBitbucket への接続設定

まずは、本記事右側のサイドバーからBitbucket JDBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

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

DBeaver アプリケーションを開き、「データベース」メニューの「ドライバーマネジャー」オプションを選択します。「新規」をクリックして「新しいドライバを作成する」フォームを開きます。
設定タブで：
- ドライバ名をわかりやすい名前に設定します（例：CData JDBC Driver for Bitbucket）。
- クラス名をJDBC ドライバーのクラス名「cdata.jdbc.bitbucket.BitbucketDriver」に設定します。
- URL テンプレートをjdbc:bitbucket: に設定します。
ライブラリタブで「ファイルを追加」をクリックし、インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for Bitbucket XXXX\）の「lib」フォルダに移動してJAR ファイル（cdata.jdbc.Bitbucket.jar）を選択します。

Bitbucket のデータの接続を作成

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

「データベース」メニューで、「新しい接続」をクリックします。
表示される「新しい接続を作成する」ウィザードで、先ほど作成したドライバー（例：CData JDBC Driver for Bitbucket）を選択し、「次へ >」をクリックします。
設定ウィザードの一般タブで、以下を参考に必要な接続プロパティを使用してJDBC URL を設定します。
ほとんどのクエリでは、ワークスペースを設定する必要があります。唯一の例外は、Workspacesテーブルです。このテーブルはこのプロパティの設定を必要とせず、クエリを実行すると、Workspaceの設定に使用できるワークスペーススラッグのリストが提供されます。このテーブルにクエリを実行するには、スキーマを'Information'に設定し、SELECT * FROM Workspacesクエリを実行する必要があります。

Schemaを'Information'に設定すると、一般的な情報が表示されます。Bitbucketに接続するには、以下のパラメータを設定してください。
- Schema: ワークスペースのユーザー、リポジトリ、プロジェクトなどの一般的な情報を表示するには、これを'Information'に設定します。それ以外の場合は、クエリを実行するリポジトリまたはプロジェクトのスキーマに設定します。利用可能なスキーマの完全なセットを取得するには、sys_schemasテーブルにクエリを実行してください。
- Workspace: Workspacesテーブルにクエリを実行する場合を除き、必須です。Workspacesテーブルへのクエリにはこのプロパティは必要ありません。そのクエリはWorkspaceの設定に使用できるワークスペーススラッグのリストのみを返すためです。
Bitbucketでの認証

BitbucketはOAuth認証のみをサポートしています。すべてのOAuthフローからこの認証を有効にするには、カスタムOAuthアプリケーションを作成し、AuthSchemeをOAuthに設定する必要があります。

特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを必ず確認してください。

カスタムOAuthアプリケーションの作成

Bitbucketアカウントから、以下のステップを実行します。
1. 設定（歯車アイコン）に移動し、ワークスペース設定を選択します。
2. アプリと機能セクションで、OAuthコンシューマーを選択します。
3. コンシューマーを追加をクリックします。
4. カスタムアプリケーションの名前と説明を入力します。
5. コールバックURLを設定します。
  - デスクトップアプリケーションとヘッドレスマシンの場合、http://localhost:33333または任意のポート番号を使用します。ここで設定するURIがCallbackURLプロパティになります。
  - Webアプリケーションの場合、信頼できるリダイレクトURLにコールバックURLを設定します。このURLは、ユーザーがアプリケーションにアクセスが許可されたことを確認するトークンを持って戻るWebの場所です。
6. クライアント認証情報を使用して認証する予定の場合、これはプライベートコンシューマーですを選択する必要があります。ドライバーでは、AuthSchemeをclientに設定する必要があります。
7. OAuthアプリケーションに与える権限を選択します。これにより、読み取りおよび書き込みできるデータが決まります。
8. 新しいカスタムアプリケーションを保存するには、保存をクリックします。
9. アプリケーションが保存された後、それを選択して設定を表示できます。アプリケーションのKeyとSecretが表示されます。これらを将来の使用のために記録してください。Keyを使用してOAuthClientIdを設定し、Secretを使用してOAuthClientSecretを設定します。
組み込みの接続文字列デザイナー

JDBC URL の作成の補助として、Bitbucket JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.bitbucket.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

一般的な接続文字列：
jdbc:bitbucket:Workspace=myworkspaceslug;Schema=InformationInitiateOAuth=GETANDREFRESH
「テスト接続」をクリックして、接続が正しく設定されていることを確認します。
「終了」をクリックします。