Clio のデータ のPostgreSQL インターフェースを作成

加藤龍彦
加藤龍彦
デジタルマーケティング
Clio JDBC Driver のリモート機能を使用し、データアクセス用のPostgreSQL エントリポイントを作成します。

PostgreSQL には多くの対応クライアントがあります。標準のドライバーからBI、アナリティクスツールまで、PostgreSQL はデータ接続の人気のインターフェースです。JDBC ドライバーを使用することで、簡単に任意の標準クライアントから接続できるPostgreSQL エントリポイントを作成できます。

Clio にPostgreSQL データベースとしてアクセスするには、CData JDBC Driver for API とJDBC foreign data wrapper (FDW) を使用します。この記事ではFDW をコンパイルしてインストールし、PostgreSQL サーバーからClio にクエリを実行します。

JDBC データソースとしてClio のデータに接続する

JDBC データソースとしてClio に接続するには、以下が必要です。

  • Driver のJAR パス:JAR ファイルは、インストールディレクトリのlib サブフォルダにあります。
  • Driver クラス

    cdata.jdbc.api.APIDriver
    
  • JDBC URL: URL は、"jdbc:api:" で始まり、セミコロンで区切られた名前と値の組み合わせで任意の接続プロパティを含めることができます。

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

    Clio API プロファイル設定

    Clio はOAuth ベースの認証を使用します。

    まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id(キー)とclient secret(シークレット)が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

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

    • AuthScheme:OAuth に設定します。
    • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId:アプリ設定で指定されたclient_id に設定します。
    • OAuthClientSecret:アプリ設定で指定されたclient_secret に設定します。
    • CallbackURL:アプリ設定で指定されたRedirect URI に設定します。
    • Region:ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。

    ビルトイン接続文字列デザイナ

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

    java -jar cdata.jdbc.api.jar
    

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

    Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)

    以下は一般的なJDBC URL です。

    jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
    

JDBC FDW を構築する

FDW は、PostgreSQL を再コンパイルせずに、PostgreSQL の拡張機能としてインストールできます。例としてjdbc2_fdw 拡張子を使用します。

  1. ご使用のバージョンのJRE 共有オブジェクトから、/usr/lib/libjvm.so にシンボリックリンクを追加します。コマンド例:
    ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
    
  2. ビルドするには、以下のコマンドを実行してください。
    make install USE_PGXS=1
    

Clio のデータをPostgreSQL データベースとしてクエリする

拡張機能をインストールした後、以下のステップに従ってClio へのクエリの実行を開始します。

  1. データベースにログイン
  2. データベースの拡張機能をロード
    CREATE EXTENSION jdbc2_fdw;
    
  3. Clio のオブジェクトを作成
    CREATE SERVER API
    FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
    drivername 'cdata.jdbc.api.APIDriver',
    url 'jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;',
    querytimeout '15',
    jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.api.jar');
    
  4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成
    CREATE USER MAPPING for postgres SERVER API OPTIONS (
    username 'admin',
    password 'test');
    
  5. ローカルデータベースに外部テーブルを作成
    postgres=# CREATE FOREIGN TABLE bills (
    bills_id text,
    bills_Id text,
    bills_Total numeric)
    SERVER API OPTIONS (
    table_name 'bills');
    
Clio に対してSELECTコマンドを実行可能にする
postgres=# SELECT * FROM bills;

おわりに

このようにCData JDBC Driver for API を使って簡単にClio のデータを取得して検索対象にすることができました。ぜひ、30日の無償評価版 をお試しください。

はじめる準備はできましたか?

API Driver で Clio のライブデータに接続

Clio に接続 お問い合わせ