DbVisualizer でInsightly のデータに連携しクエリを作成
CData JDBC Driver for API は、JDBC 標準に準拠し、BI ツールからIDE まで幅広いアプリケーションでInsightly のデータへの接続を提供します。この記事では、DbVisualizer からInsightly のデータに接続する方法、およびtable エディタを使ってInsightly をロード、する方法を説明します。
CData JDBC ドライバとは?
CData JDBC ドライバは、以下の特徴を持ったリアルタイムデータ接続ツールです。
- Insightly をはじめとする、CRM、MA、グループウェア、広告、会計ツールなど多様な270種類以上のSaaS / DB に対応
- DBeaver を含む多様なアプリケーション、ツールにInsightly のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData JDBC ドライバでは、1.データソースとしてInsightly の接続を設定、2.DBeaver 側でJDBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
Insightly のデータの新しいドライバー定義を作成
下記の手順に従い、Driver Manager を使ってDbVisualizer ツールからInsightly のデータに接続します。
- DbVisualizer で「Tools」->「Driver Manager」をクリックします。
- 「」ボタンをクリックして新しくドライバーを作成します。
- テンプレートは「Custom」を選択します。
- Driver Settings タブで:
- Name をわかりやすい名前に設定します(例:CData Insightly Driver)。
- URL Format をjdbc:api: に設定します。
- Driver artifacts and jar files (jars are loaded in order from top) セクションで:
- 「」ボタンをクリックして、「Add Files」に進みます。
- インストールディレクトリ(C:\Program Files\CData\CData JDBC Driver for Insightly XXXX\)の「lib」フォルダに移動します。
- JAR ファイル(cdata.jdbc.API.jar)を選択して「Open」をクリックします。
- Driver Class は自動的に入力されます。もし入力されない場合は、クラス(cdata.jdbc.api.APIDriver)を選択してください。
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:api: に続けてセミコロン区切りでname-value ペアの接続プロパティを入力します。
まず、Profile 接続プロパティをディスク上の Insightly プロファイルの場所に設定します(例:C:\profiles\Insightly.apip)。次に、ProfileSettings 接続プロパティを Insightly の接続文字列に設定します(以下を参照)。
Insightly API プロファイル設定
Insightly のプロファイルに移動し、「User Settings > API」を選択して API キーを確認します。Pod の値(例:
)は、API URL のサブドメインから決まります。na1組み込みの接続文字列デザイナー
JDBC URL の作成の補助として、Insightly JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.api.jar接続プロパティを入力し、接続文字列をクリップボードにコピーします。
JDBC URL を構成する際に、Max Rows 接続プロパティを設定することもできます。この設定は返される行数を制限するため、レポートやビジュアライゼーションを作成する際のパフォーマンスが向上します。
一般的な接続文字列は次のとおりです。
jdbc:api:Profile=C:\profiles\Insightly.apip;ProfileSettings='APIKey=your_api_key;Pod=na1';- NOTE:Insightly は認証にUser やPassword を必要としないため、Database Userid とDatabase Password には任意の値を使用できます。
- 「Connection」タブで「Connect」をクリックします。
Insightly JDBC Driver が表示するテーブルをブラウズするには、テーブルを右クリックして「Open In New Tab」をクリックします。
SQL クエリの実行には、SQL Commander ツールを使用します。「SQL Commander」->「New SQL Commander」をクリックします。利用可能なメニューから「Database Connection」、「Database」、「Schema」を選択します。
サポートされるSQL についての詳細は、ヘルプドキュメントの「サポートされるSQL」をご覧ください。テーブルに関する情報は「データモデル」をご覧ください。