Squirrel SQL Client からCarbone のデータに連携

CData JDBC Driver for API を使用して、Squirrel SQL Client などのツールでCarbone へのクエリを実行できます。この記事では、JDBC data source for API を作成し、クエリを実行します。

JDBC Driver for API を追加する

以下のステップに従ってドライバーJAR を追加します。

1. Squirrel SQL で［Windows］->［View Drivers］と進みます。
2. プラスアイコンをクリックし、［Add Driver］ウィザードを開きます。
3. ［Name］ボックスで、CData JDBC Driver for API のようなドライバーのわかりやすい名前を入力します。
4. ［Example URL］ボックスで、jdbc:api: と入力します。
5. ［Extra Class Path］タブで［Add］をクリックします。
6. 表示される［file explorer］ダイアログで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルを選択します。
7. ［List Drivers］をクリックして［Class Name］メニューにドライバーのクラス名(cdata.jdbc.api.APIDriver) を入力します。

接続プロパティを定義する

以下のステップに従って、接続プロパティをドライバーエイリアスに保存します。

1. ［Windows］->［View Aliases］と進みます。
2. エイリアスが一覧表示されているペインで、プラスアイコンをクリックします。

3. 表示される［Add Alias］ウィザードで、JDBC ドライバーには以下のフィールドが要求されます。

   • Name:CData Carbone Source のようなエイリアスの名前を入力します。
   • Driver:CData JDBC Driver for API を選択します。
   • URL:jdbc:api: と入力します。
   
4. 追加のプロパティを定義する場合は、［Properties］をクリックします。
5. 表示されるダイアログの［Driver properties］タブで、［Use driver properties］のチェックボックスを選択します。
6. ［Specify］カラムで必要な接続プロパティのチェックボックスを選択します。

   まず、Profile 接続プロパティをディスク上の Carbone プロファイルの場所に設定します（例：C:\profiles\Carbone.apip）。次に、ProfileSettings 接続プロパティを Carbone の接続文字列に設定します（以下を参照）。

   Carbone API プロファイル設定

   Carbone では、Authorization ヘッダーの Bearer トークンによる API キー認証を使用します。API キーは以下の手順で取得できます。

   1. https://account.carbone.io で Carbone アカウントにログインします。
   2. アカウントのホームページに表示されている API キーをコピーします。

   API キーを取得したら、以下の接続プロパティを設定します。

   • AuthScheme：APIKey に設定します。
   • APIKey：Carbone の API キー（Bearer トークン）に設定します。
   • CarboneVersion：（オプション）carbone-version リクエストヘッダーで指定する、対象の Carbone API のメジャーバージョンです。デフォルトは 5 です。指定できる値は 5、4、3、staging です。

   以下は一般的な接続文字列です。

   
   jdbc:api:Profile=C:\profiles\Carbone.apip;AuthScheme=APIKey;APIKey=your_api_key;
   

   
7. ［OK］をクリックし、表示されるダイアログで［connect］をクリックして接続を確認します。

スキーマを検出しCarbone のデータをクエリする

メタデータが読み込まれると、Carbone のデータソースの新しいタブが表示されます。［Objects］サブタブでは、使用可能なテーブルやビューなどのスキーマ情報を見つけることができます。

テーブルデータを表示するには［Objects］タブでテーブルを選択します。その後、テーブルデータが［Content］タブのグリッドに読み込まれます。

SQL クエリを実行するには、［SQL］タブにクエリを入力し、［Run SQL］(ランナーアイコン)をクリックします。例：

SELECT Id, Name FROM Templates WHERE Category = 'Invoices'