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

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

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

最終更新日:2024-03-08

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

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

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

CData JDBC ドライバとは?

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

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

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

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

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

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

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:rest: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。

      データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル(ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー)を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

      URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

      DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

      • Document (デフォルト):REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
      • FlattenedDocuments:ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
      • Relational:階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

      リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

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

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

      java -jar cdata.jdbc.rest.jar

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

      組み込みの接続文字列デザイナーを使ってJDBC URL を生成(Salesforce の場合)

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

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

      jdbc:rest:DataModel=Relational;URI=C:/people.xml;Format=XML;
    • NOTE:REST は認証にUser やPassword を必要としないため、Database UseridDatabase Password には任意の値を使用できます。
  3. 「Connection」タブで「Connect」をクリックします。 新しく設定されたデータベース接続(Salesforce の場合)。

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

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

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

DBVisualizer でクエリを実行した結果(Salesforce の場合)。

おわりに

CData JDBC Driver for REST の 30日間無償トライアル をダウンロードして、DbVisualizer でリアルタイムREST のデータの操作をはじめましょう!ご不明な点があれば、サポートチームにお問い合わせください。

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。