DataGrip で Harvest のデータ をクエリ

DataGrip は、SQL 開発者がデータベースへのクエリ、作成、管理を行えるデータベース IDE です。CData API Driver for JDBC と組み合わせることで、DataGrip からリアルタイムHarvest のデータを操作できます。この記事では、DataGrip で Harvest のデータ への接続を確立方法を説明します。

Harvest 用の新しいドライバー定義を作成

以下のステップでは、DataGrip で Harvest 用の新しいデータソースを作成する方法を説明します。

1. DataGrip で、File -> New -> Project をクリックしてプロジェクト名を入力します。
2. Database Explorer で、プラスアイコン（）をクリックして Driver を選択します。
3. Driver タブで以下を設定します。
   • Name をわかりやすい名前に設定します（例："CData Harvest Driver"）。
   • Driver Files を適切な JAR ファイルに設定します。ファイルを追加するには、プラス（）をクリックし、「Add Files」を選択して、ドライバーのインストールディレクトリ内の「lib」フォルダに移動し、JAR ファイル（例：cdata.jdbc.api.jar）を選択します。
   • Class を cdata.jdbc.api.API.jar に設定します。
   また、詳細タブでは、ドライバーのプロパティや、VM Options、VM environment、VM home path、DBMS などの設定を変更できます。
   • ほとんどの場合、Expert options で DBMS type を「Unknown」に変更して、ネイティブの SQL Server クエリ（Transact-SQL）を回避してください。これを行わないと、無効な関数エラーが発生する可能性があります。
4. 「Apply」をクリックし、「OK」をクリックして接続を保存します。

Harvest への接続を設定

1. 接続を保存したら、プラス（）をクリックし、「Data Source」→「CData Harvest Driver」を選択して、新しい Harvest データソースを作成します。
2. 新しいウィンドウで、JDBC URL を使用して Harvest への接続を設定します。

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

   JDBC URL の構築には、Harvest JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。

         java -jar cdata.jdbc.api.jar
       

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

   まず、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 を取得および更新する方法を管理できます。
   
3. URL を接続文字列に設定します。例：

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

4. 「Apply」と「OK」をクリックして接続文字列を保存します。

これで、Data Explorer にデータソースが表示されます。

Harvest に対して SQL クエリを実行

JDBC Driver を介してアクセス可能な Harvest のエンティティ（テーブルとして利用可能）を参照するには、データソースを展開します。

クエリを実行するには、任意のテーブルを右クリックして「New」→「Query Console」を選択します。

Console で、実行したい SQL クエリを記述します。例：

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

CData API Driver for JDBC の30日間の無料トライアルをダウンロードして、DataGrip でリアルタイムHarvest のデータを操作してみてください。ご不明な点があれば、サポートチームにお問い合わせください。