TIBCO Data Virtualization で Lakebase のデータ にリアルタイムアクセスする方法

TIBCO Data Virtualization（TDV）は、複数の多様なデータソースへのアクセスを一元管理するエンタープライズデータ仮想化ソリューションです。CData TIBCO DV Adapter for Lakebase と組み合わせることで、TIBCO Data Virtualization 内からLakebase のデータに直接フェデレーテッドアクセスが可能になります。この記事では、アダプターのデプロイと Lakebase に基づく新しいデータソースの作成手順を解説します。

CData TIBCO DV Adapter は、最適化されたデータ処理機能が組み込まれており、Lakebase のデータ とのインタラクションにおいて比類のないパフォーマンスを発揮します。Lakebase に対して複雑な SQL クエリを発行すると、アダプターはフィルタや集計などサポートされている SQL 操作を直接 Lakebase にプッシュします。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してLakebase のデータを操作・分析できます。

Lakebase TIBCO DV Adapter のデプロイ

1. コンソールで、TDV Server のインストールディレクトリ内の bin フォルダに移動します。現在のバージョンのアダプターがインストールされている場合は、先にアンデプロイする必要があります。

   .\server_util.bat -server localhost -user admin -password ******** -undeploy -version 1 -name Lakebase
   

2. CData TIBCO DV Adapter をローカルフォルダに解凍し、解凍した場所から JAR ファイル（tdv.lakebase.jar）をサーバーにデプロイします。

   .\server_util.bat -server localhost -user admin -password ******** -deploy -package /PATH/TO/tdv.lakebase.jar
   

新しい JAR ファイルが正しくロードされるように、サーバーの再起動が必要な場合があります。再起動は、C:\Program Files\TIBCO\TDV Server <version>\bin にある composite.bat スクリプトを実行して行えます。サーバーを再起動した後は、TDV Studio への再認証が必要です。

再起動コマンドの例

.\composite.bat monitor restart

OAuth を使用して Lakebase で認証する

Lakebase は OAuth プロトコルを使用して認証を行いますが、TDV Studio は内部でブラウザベースの認証をサポートしていないため、OAuth トークンを取得するための簡単な Java アプリケーションを作成して実行する必要があります。取得したトークンは、アダプターから直接 Lakebase に接続するために使用されます。

Create the Java Application

1. Create a new Java file with preferred name for example GenOAuthSettings.java. This Java file leverages the LakebaseOAuth class contained within the TDV Adapter JAR to initiate a test connection and perform the required OAuth authentication flow
2. Copy and insert the following code into the .java file:

public class GenOAuthSettings {
    public static void main(String[] args) {
        try {
    	    if (args.length != 2) {
    			throw new Exception("Input must have two arguments: 'data source', 'connection string'");
    		}
    
    		String source = args[0].replace(" ", "").toLowerCase();
    		String connectionString = args[1];
    		String prefix;
    
    		if (source.equals("lakebase")) {
    			prefix = "jdbc:lakebase:";
    
    			com.cdata.cis.lakebase.LakebaseOAuth oauth = new com.cdata.cis.lakebase.LakebaseOAuth();
    
    			if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
    			oauth.generateOAuthSettingsFile(connectionString);
    		}
    		// More sources can be added below using the same format.  You must add the import statement and ensure the jar file resides in the classpath
			//            else if (source.equals("googlebigquery") || source.equals("bigquery")) {
			//                prefix = "jdbc:googlebigquery:";
			//
			//                com.cdata.cis.googlebigquery.GoogleBigQueryOAuth oauth = new com.cdata.cis.googlebigquery.GoogleBigQueryOAuth();
			//
			//                if (!connectionString.startsWith(prefix)) connectionString = prefix + connectionString;
			//                oauth.generateOAuthSettingsFile(connectionString);
			//            }
    		else {
				throw new Exception("Data Source not supported.  Available Data Sources: Lakebase");
			}
			
			System.out.println("Test Connection Successful!");
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

3. Place the .java file in the same directory as the tdv.lakebase.jar file. This is required to prevent classpath resolution errors during compilation and execution

Build and run the Java Application

1. Open Console and navigate to the directory containing the .java file and adapter jar
2. Compile the Java file using the following command:

javac -cp .;tdv.lakebase.jar GenOAuthSettings.java

3. Execute the application using one of the following commands:

java -cp .;tdv.lakebase.jar GenOAuthSettings "Lakebase" "connection string"

This command initiates the OAuth authentication flow and generates the OAuth settings file at the location specified in the OAuthSettingsLocation parameter. Once you deploy the adapter and authenticate, you can create a new data source for Lakebase in TDV Studio.

TDV Studio で Lakebase データソースを作成する

CData TIBCO DV Adapter for Lakebase を使用すると、Lakebase 用のデータソースを簡単に作成し、データソースをイントロスペクトしてリソースを TDV に追加できます。

データソースの作成

1. データソースを追加するフォルダを右クリックし、New -> New Data Source を選択します。
2. アダプター（例：Lakebase）が表示されるまでスクロールし、Next をクリックします。
3. データソースに名前を付けます（例：CData Lakebase Source）。

4. 必要な接続プロパティを入力します。

   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 を指定します。

   詳細については、ヘルプドキュメントをご参照ください。

   NOTE：DV Adapter の OAuthSettingsLocation プロパティには、OAuth 認証（上記参照）を実行したときと同じ値を設定してください。

   
5. Create & Close をクリックします。

データソースのイントロスペクト

データソースを作成したら、右クリックして Open を選択することでデータソースをイントロスペクトできます。ダッシュボードで Add/Remove Resources をクリックし、データソースの一部として含めるテーブル、ビュー、ストアドプロシージャを選択します。Next をクリックし、Finish をクリックして、選択した Lakebase のテーブル、ビュー、ストアドプロシージャをリソースとして追加します。

After creating and introspecting the data source, you are ready to work with Lakebase のデータ in TIBCO Data Virtualization just like you would any other relational data source. You can create views, query using SQL, publish the data source, and more.

データソースを作成してイントロスペクトしたら、他のリレーショナルデータソースと同様に TIBCO Data Virtualization でLakebase のデータを操作できるようになります。ビューの作成、SQL によるクエリ、データソースの公開など、さまざまな操作が可能です。