DataGrip で freee のデータ をクエリ
DataGrip は、SQL 開発者がデータベースへのクエリ、作成、管理を行えるデータベース IDE です。CData API Driver for JDBC と組み合わせることで、DataGrip からリアルタイムfreee のデータを操作できます。この記事では、DataGrip で freee のデータ への接続を確立方法を説明します。
freee 用の新しいドライバー定義を作成
以下のステップでは、DataGrip で freee 用の新しいデータソースを作成する方法を説明します。
- DataGrip で、File -> New -> Project をクリックしてプロジェクト名を入力します。
- Database Explorer で、プラスアイコン()をクリックして Driver を選択します。
- Driver タブで以下を設定します。
- Name をわかりやすい名前に設定します(例:"CData freee 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)を回避してください。これを行わないと、無効な関数エラーが発生する可能性があります。
- 「Apply」をクリックし、「OK」をクリックして接続を保存します。
freee への接続を設定
- 接続を保存したら、プラス()をクリックし、「Data Source」→「CData freee Driver」を選択して、新しい freee データソースを作成します。
- 新しいウィンドウで、JDBC URL を使用して freee への接続を設定します。
組み込みの接続文字列デザイナー
JDBC URL の構築には、freee JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行します。
java -jar cdata.jdbc.api.jar接続プロパティを入力し、接続文字列をクリップボードにコピーします。
まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
- AuthScheme:OAuth に設定します。
- OAuthClientID:アプリ設定で指定されたOAuth クライアントID に設定します。
- OAuthClientSecret:アプリ設定で指定されたOAuth クライアントシークレットに設定します。
- CallbackURL:アプリ設定で指定したリダイレクトURI に設定します。
- InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
- URL を接続文字列に設定します。例:
jdbc:api:Profile=freee.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
- 「Apply」と「OK」をクリックして接続文字列を保存します。
これで、Data Explorer にデータソースが表示されます。
freee に対して SQL クエリを実行
JDBC Driver を介してアクセス可能な freee のエンティティ(テーブルとして利用可能)を参照するには、データソースを展開します。
クエリを実行するには、任意のテーブルを右クリックして「New」→「Query Console」を選択します。
Console で、実行したい SQL クエリを記述します。例:
SELECT Amount, IssueDate FROM Deals
CData API Driver for JDBC の30日間の無料トライアルをダウンロードして、DataGrip でリアルタイムfreee のデータを操作してみてください。ご不明な点があれば、サポートチームにお問い合わせください。