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

CData JDBC Driver for API を使用して、Squirrel SQL Client などのツールでHarvest へのクエリを実行できます。この記事では、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 Harvest Source のようなエイリアスの名前を入力します。
   • Driver:CData JDBC Driver for API を選択します。
   • URL:jdbc:api: と入力します。
   
4. 追加のプロパティを定義する場合は、［Properties］をクリックします。
5. 表示されるダイアログの［Driver properties］タブで、［Use driver properties］のチェックボックスを選択します。
6. ［Specify］カラムで必要な接続プロパティのチェックボックスを選択します。

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

   Harvest API プロファイル設定

   Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

   トークン認証の使用

   トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

   OAuth 認証の使用

   まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

   以下の接続プロパティを設定すると、接続できるようになります。

   • ProfileSettings：ProfileSettings でAccountId を設定します。
   • AuthScheme：OAuth に設定します。
   • OAuthClientId：アプリ設定で指定したclient ID に設定します。
   • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
   • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

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

   jdbc:api:Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
   

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

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

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

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

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

SELECT Id, ClientName FROM Invoices WHERE State = 'open'