DbVisualizer でHubDB データに連携しクエリを作成

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

CData JDBC Driver for HubDB は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでHubDB データへの接続を提供します。この記事では、DbVisualizer からHubDB データに接続する方法、およびtable エディタを使ってHubDB を編集、および保存する方法を説明します。

CData JDBC ドライバとは？

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

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

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

HubDB データの新しいドライバー定義を作成

下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからHubDB データに接続します。

1. DbVisualizer で「Tools」->「Driver Manager」をクリックします。
2. 「」ボタンをクリックして新しくドライバーを作成します。
3. テンプレートは「Custom」を選択します。
4. Driver Settings タブで：
   • Name をわかりやすい名前に設定します（例：CData HubDB Driver）。
   • URL Format をjdbc:hubdb: に設定します。
   • Driver artifacts and jar files (jars are loaded in order from top) セクションで：
     1. 「」ボタンをクリックして、「Add Files」に進みます。
     2. インストールディレクトリ（C:\Program Files\CData\CData JDBC Driver for HubDB XXXX\）の「lib」フォルダに移動します。
     3. JAR ファイル（cdata.jdbc.HubDB.jar）を選択して「Open」をクリックします。
5. Driver Class は自動的に入力されます。もし入力されない場合は、クラス（cdata.jdbc.hubdb.HubDBDriver）を選択してください。

JDBC データソースへの接続を定義

「Driver Manager」を終了し、下記の手順に従ってJDBC URL に接続プロパティを入力します。

1. 「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。

2. 「Connection」セクションで以下のオプションを設定します。

   • Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
   • Driver Type：先ほど作成したドライバーを選択します。

   • Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:hubdb: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

     HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

     カスタムOAuthアプリを使用する

     すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

     アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

     1. HubSpotアプリ開発者アカウントにログインします。
        • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
     2. 開発者アカウントのホームページで、アプリタブをクリックします。
     3. アプリを作成をクリックします。
     4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
     5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
        • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
        • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
     6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
     7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

     8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

        テーブルにアクセスするには、最低限以下のスコープが必要です：

        • hubdb
        • oauth
        • crm.objects.owners.read
     9. 変更を保存をクリックします。
     10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
         • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
         • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
         • アプリを接続をクリックします。結果のタブは閉じて構いません。

     プライベートアプリを使用する

     HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

     以下の手順に従ってプライベートアプリケーショントークンを生成できます：

     1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
     2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
     3. プライベートアプリを作成をクリックします。
     4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
     5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
     6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
     7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
     8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
     9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

     接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

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

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

     java -jar cdata.jdbc.hubdb.jar

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

     JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。

     一般的な接続文字列は次のとおりです。

     jdbc:hubdb:AuthScheme=OAuth;OAuthClientID=MyOAuthClientID;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;InitiateOAuth=GETANDREFRESH
   • NOTE：HubDB は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
3. 「Connection」タブで「Connect」をクリックします。

HubDB JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。

SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。

サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。

おわりに