DBeaver でfreee のデータに接続

Jerod Johnson
Director, Technology Evangelism

CData ODBC Driver を使って、DBeaver からfreee に接続する方法を解説します。

NOTE: DBeaver Community Edition 23.1 以降では、レガシーODBC ドライバーが廃止されています。代わりに CData JDBC Driver を使用できます（詳細はJDBC 経由で DBeaver からfreee に接続する方法をご参照ください）。ODBC ドライバーを使用する必要がある場合は、DBeaver のドキュメントをご確認ください。

CData API Driver for ODBC は、ODBC 標準経由でfreee のリアルタイムデータにアクセスし、使い慣れた SQL クエリで各種 BI、レポート、ETL ツールからfreee のデータを利用可能にします。この記事では、DBeaver のクエリブラウザなどのビジュアルツールを使ってfreee のデータを操作する方法を解説します。

CData ODBC ドライバーは、ドライバーに組み込まれた最適化されたデータ処理により、DBeaver でのリアルタイムfreee データ操作において卓越したパフォーマンスを実現します。DBeaver からfreee に複雑な SQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされた SQL 操作を直接freee にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。また、動的メタデータクエリ機能を内蔵しているため、freee のデータを効率的に管理・分析できます。

freee への接続設定

まだ設定していない場合は、データソース名（DSN）で必要な接続プロパティを指定します。DSN の設定は Microsoft ODBC データソースアドミニストレーターを使用して行えます。これはドライバーインストールの最終ステップでもあります。Microsoft ODBC データソースアドミニストレーターを使用して DSN を作成・設定する方法については、ヘルプドキュメントの「はじめに」の章をご参照ください。

まずは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 を取得するプロセスを管理できます。

最後に、ドライバーの DSN 設定画面で「Map To WVarchar」接続プロパティを False に設定します。この設定により、文字列型が SQL_VARCHAR にマッピングされ、SQL_WVARCHAR 型が NULL として表示されるのを防ぐことができます。

DBeaver でfreee ODBC データソースに接続

DBeaver アプリケーションを開き、Database メニューから New Database Connection オプションを選択します。
「Connect to a database」ウィンドウで ODBC を選択し、Next をクリックします。
Database/Schema フィールドに DSN 名（デフォルトでは CData freee Source）を入力します。この名前は JDBC URL にも自動的に追加されます。
Test Connection ボタンをクリックします。DBeaver が DSN を検出すると「Connected」メッセージが表示され、接続が成功した場合はドライバーの詳細情報も表示されます。