Apache NiFi で Shopify に接続

Dibyendu Datta
Lead Technology Evangelist

CData JDBC Driver を使用して Apache NiFi で Shopify のデータにアクセスして処理できます。

Apache NiFi は、強力かつスケーラブルなデータルーティング、変換、システム間連携ロジックの有向グラフをサポートしています。CData JDBC Driver for Shopify と組み合わせることで、NiFi からリアルタイムのShopify のデータを操作できます。この記事では、Apache NiFi Flow からShopify のデータに接続してクエリを実行する方法を説明します。

CData JDBC Driver は、最適化されたデータ処理機能が組み込まれており、リアルタイムのShopify のデータとのやり取りにおいて比類のないパフォーマンスを提供します。複雑なSQL クエリをShopify に発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Shopify にプッシュし、サポートされていない操作（多くの場合SQL 関数やJOIN 操作）は組み込みのSQL エンジンでクライアント側に処理します。また、組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してShopify のデータを操作・分析できます。

Apache NiFi でShopify のデータに接続

CData JDBC Driver for Shopify のインストーラーをダウンロードし、パッケージを解凍して、.exe ファイルを実行してドライバーをインストールします。
CData JDBC Driver のJAR ファイル（およびライセンスファイルがある場合はそれも）、cdata.jdbc.shopify.jar（および cdata.jdbc.shopify.lic）を Apache NiFi の lib サブフォルダにコピーします（例：C:\nifi-1.3.0-bin\nifi-1.3.0\lib）。

Windows では、CData JDBC Driver のデフォルトのインストール場所は C:\Program Files\CData\CData JDBC Driver for Shopify です。
bin サブフォルダにある run-nifi.bat ファイルを実行して Apache NiFi を起動します（例：C:\nifi-1.3.0-bin\nifi-1.3.0\bin）。

（または）

コマンドプロンプトで対象のディレクトリに移動し、run-nifi.bat ファイルを実行します：
```
cd C:\nifi-1.3.0-bin\nifi-1.3.0\bin
.\run-nifi.bat
```
Web ブラウザで Apache NiFi の UI に移動します：https://localhost:8443/nifi でアクセスできます。

注意：古いバージョンの Apache NiFi を使用している場合は、http://localhost:8080/nifi からアクセスする必要があります。以前のバージョンでは HTTP プロトコルが使用されていましたが、最新バージョンでは HTTPS が標準になっています。デフォルトでは、HTTP はポート 8080 で動作し、HTTPS はポート 8443 を使用します。
URL から Apache NiFi にアクセスすると、ログイン用のユーザー名とパスワードの入力を求められます。

ログイン資格情報を取得するには、NiFi のインストールディレクトリ内の log ディレクトリにある「App.log」ファイルを確認してください。このファイルには通常、NiFi インターフェースにアクセスするために必要な情報が含まれています。
NiFi Flow のワークスペースを右クリックし、「Controller Services」をクリックします。
ボタンをクリックして、新しいコントローラーサービスを作成します。
Controller Services セクションで、新しく作成した「DBCPConnection Pool」を見つけ、メニュー（）から「Edit」をクリックして新しい接続を設定します。
以下のプロパティを入力します：
- Database Connection URL：jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
- Database Driver Class Name：cdata.jdbc.shopify.ShopifyDriver
- Database Driver Location(s)：Apache NiFi の lib フォルダへのパス（JAR ファイルが配置されている場所）。
組み込みの接続文字列デザイナー

JDBC URL の構築には、Shopify JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
```
java -jar cdata.jdbc.shopify.jar
```
接続プロパティを入力し、接続文字列をクリップボードにコピーします。

それでは、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 認証の使用」をご確認ください。
Controller Services セクションで、新しく作成した DBCPConnection Pool を見つけ、メニュー（）から「Enable」をクリックして新しい接続を有効にします。
「Enable Controller Service」ウィンドウで、Scope を「Service and referencing components」に設定します。
接続を確立し、SELECT クエリを実行するには、プロセッサー（黄色でハイライトされている部分）をワークスペースにドラッグ＆ドロップします。
「ExecuteSQL」プロセッサーを選択し、「Add」ボタンをクリックしてワークスペースに表示させます。
追加したプロセッサー（ExecuteSQL）をダブルクリックして、接続ページを開きます。
Properties セクションで、必要な情報を入力します。Database Connection Pooling Service を作成した DBCPConnectionPool に一致させ、SQL select query セクションに実行したい SQL クエリを設定してください。
Relationships に移動し、実行プロセスの成功時と失敗時にコンポーネントがどのように処理を進めるかのオプションを選択してください。
ExecuteSQL コンポーネントを有効にするには、それを選択して Operation セクションの「Enable」をクリックするか、右クリックして「Enable」を選択します。