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

加藤龍彦
デジタルマーケティング

DbVisualizer のビジュアルデータ分析ツールやデータ接続ウィザードにLakebase のデータを連携する方法を紹介します。

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

CData JDBC ドライバとは？

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

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

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

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

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

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

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

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

「Databases」タブで「」ボタンをクリックし、先ほど作成したドライバーを選択します。
「Connection」セクションで以下のオプションを設定します。
- Database Type：ウィザードオプションを選択した場合は、データベースの種類は自動検出されます。「No Wizard」オプションを選択した場合は、「Database Type」メニューから「Generic」または「Auto Detect」オプションを選択します。
- Driver Type：先ほど作成したドライバーを選択します。
- Database URL：完全なJDBC URL を入力します。JDBC URL 構文は、jdbc:lakebase: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。
  
  Databricks Lakebase に接続するには、以下のプロパティを設定します。
  - DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
  - Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
  - Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
  - Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。
  OAuth クライアント認証
  
  OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。
  1. 新しいサービスプリンシパルを作成・構成する
  2. サービスプリンシパルに権限を割り当てる
  3. サービスプリンシパル用の OAuth シークレットを作成する
  詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。
  
  OAuth PKCE 認証
  
  PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。
  - AuthScheme: OAuthPKCE を指定します。
  - User: 認証ユーザーのユーザー ID を指定します。
  詳細については、ヘルプドキュメントをご参照ください。
  
  組み込みの接続文字列デザイナー
  
  JDBC URL の作成の補助として、Lakebase JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
```
java -jar cdata.jdbc.lakebase.jar
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。
  
  一般的な接続文字列は次のとおりです。
```
jdbc:lakebase:DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;
```
- NOTE：Lakebase は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
「Connection」タブで「Connect」をクリックします。