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

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

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

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

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

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

• Driver クラス

  
  cdata.jdbc.api.APIDriver
  

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

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

  Yotpo API プロファイル設定

  Yotpo への認証には、Yotpo の AppKey と AppSecret を使った OAuth 2.0 クライアントクレデンシャルフローを利用できます。

  Yotpo API を使用するには、AppKey と AppSecret を持つ Yotpo ストアアカウントが必要です。これらの認証情報は、Yotpo ダッシュボードの「Account Settings」>「Store」で確認できます。

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

  • AuthScheme：OAuthClient に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：Yotpo の AppKey に設定します。
  • OAuthClientSecret：Yotpo の AppSecret に設定します。

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

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

  
  java -jar cdata.jdbc.api.jar
  

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

  

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

  
  jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;
  

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
   

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

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

1. データベースにログイン
2. データベースの拡張機能をロード

   
   CREATE EXTENSION jdbc2_fdw;
   

3. Yotpo のオブジェクトを作成

   
   CREATE SERVER API
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.api.APIDriver',
   url 'jdbc:api:Profile=C:\profiles\Yotpo.apip;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_app_key;OAuthClientSecret=your_app_secret;',
   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 productbottomline (
   productbottomline_id text,
   productbottomline_TotalReview text,
   productbottomline_AverageScore numeric)
   SERVER API OPTIONS (
   table_name 'productbottomline');
   

postgres=# SELECT * FROM productbottomline;

おわりに

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