Squirrel SQL Client からfreee Project Management のデータに連携
CData JDBC Driver for API を使用して、Squirrel SQL Client などのツールでfreee Project Management へのクエリを実行できます。この記事では、JDBC data source for API を作成し、クエリを実行します。
JDBC Driver for API を追加する
以下のステップに従ってドライバーJAR を追加します。
- Squirrel SQL で[Windows]->[View Drivers]と進みます。
- プラスアイコンをクリックし、[Add Driver]ウィザードを開きます。
- [Name]ボックスで、CData JDBC Driver for API のようなドライバーのわかりやすい名前を入力します。
- [Example URL]ボックスで、jdbc:api: と入力します。
- [Extra Class Path]タブで[Add]をクリックします。
- 表示される[file explorer]ダイアログで、インストールディレクトリのlib サブフォルダにあるドライバーのJAR ファイルを選択します。
- [List Drivers]をクリックして[Class Name]メニューにドライバーのクラス名(cdata.jdbc.api.APIDriver) を入力します。
接続プロパティを定義する
以下のステップに従って、接続プロパティをドライバーエイリアスに保存します。
- [Windows]->[View Aliases]と進みます。
- エイリアスが一覧表示されているペインで、プラスアイコンをクリックします。
表示される[Add Alias]ウィザードで、JDBC ドライバーには以下のフィールドが要求されます。
- Name:CData freee Project Management Source のようなエイリアスの名前を入力します。
- Driver:CData JDBC Driver for API を選択します。
- URL:jdbc:api: と入力します。
- 追加のプロパティを定義する場合は、[Properties]をクリックします。
- 表示されるダイアログの[Driver properties]タブで、[Use driver properties]のチェックボックスを選択します。
- [Specify]カラムで必要な接続プロパティのチェックボックスを選択します。
まずは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 を取得するプロセスを管理できます。
以下は一般的な接続文字列です。
jdbc:api:Profile=freeepm.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
- [OK]をクリックし、表示されるダイアログで[connect]をクリックして接続を確認します。
スキーマを検出しfreee Project Management のデータをクエリする
メタデータが読み込まれると、freee Project Management のデータソースの新しいタブが表示されます。[Objects]サブタブでは、使用可能なテーブルやビューなどのスキーマ情報を見つけることができます。
テーブルデータを表示するには[Objects]タブでテーブルを選択します。その後、テーブルデータが[Content]タブのグリッドに読み込まれます。
SQL クエリを実行するには、[SQL]タブにクエリを入力し、[Run SQL](ランナーアイコン)をクリックします。例:
SELECT Id, ProjectName FROM Projects