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

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

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

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

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

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

• Driver クラス

  cdata.jdbc.shopify.ShopifyDriver
  

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

  それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。

  アクセストークンによる接続

  アクセストークン経由の接続には、以下の2つのステップが必要です。

  1. Shopify の管理画面でアクセストークンを作成
  2. アクセストークンを使用して認証

  アクセストークンの作成

  まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。

  1. 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
  2. Develop apps をクリックしてCreate an app を選択します
  3. Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
  4. Save をクリックします
  5. Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです：
     • unauthenticated_read_content
  6. Save をクリックします
  7. API Credentials を選択します
  8. "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
  9. Admin API Access token のアクセストークンをコピーします。注意：トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください

  アクセストークンによる認証

  続いて、アクセストークンで認証するには、以下のプロパティを設定してください。

  • AuthScheme：AccessToken に設定
  • AccessToken：カスタムアプリからコピーしたアクセストークンの値に設定

  OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。

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

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

  java -jar cdata.jdbc.shopify.jar
  

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

  

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

  jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
  

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
   

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

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

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

   CREATE EXTENSION jdbc2_fdw;
   

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

   CREATE SERVER Shopify
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.shopify.ShopifyDriver',
   url 'jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.shopify.jar');
   

4. PostgreSQL デーモンに認識されているユーザーのユーザー名とパスワードのユーザーマッピングを作成

   CREATE USER MAPPING for postgres SERVER Shopify OPTIONS (
   username 'admin',
   password 'test');
   

5. ローカルデータベースに外部テーブルを作成

   postgres=# CREATE FOREIGN TABLE customers (
   customers_id text,
   customers_FirstName text,
   customers_Id numeric)
   SERVER Shopify OPTIONS (
   table_name 'customers');
   

postgres=# SELECT * FROM customers;

おわりに

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