Apache NiFi でShopify のデータにバッチ操作を実行

Apache NiFi は、データルーティング、変換、およびシステム間連携ロジックを強力かつスケーラブルに構築できるプラットフォームです。CData JDBC Driver for Shopify と組み合わせることで、NiFi からリアルタイムShopify のデータを操作できるようになります。この記事では、CSV ファイルからデータを読み取り、Apache NiFi（バージョン1.9.0 以降）でCData JDBC Driver forShopify のデータを使用してバッチ操作（INSERT/UPDATE/DELETE）を実行する方法を説明します。

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

JDBC URL の生成

Apache NiFi からShopify のデータに接続するには、JDBC URL が必要です。

組み込みの接続文字列デザイナー

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 認証の使用」をご確認ください。

Apache NiFi でのバッチ操作（INSERT/UPDATE/DELETE）

以下のサンプルフローは、次のNiFi プロセッサに基づいています：

• ListFile - ローカルファイルシステムからファイルリストを取得し、取得した各ファイルにFlowFile を作成します。
• FetchFile - ListFile プロセッサから受け取ったFlowFile のコンテンツを読み取ります。
• PutDatabaseRecord - 指定されたRecordReader を使用して、FetchFile プロセッサからのフローファイルからレコードを入力します。これらのレコードはSQL 文に変換され、単一のトランザクションとして実行されます。
• LogAttribute - 指定されたログレベルでFlowFile の属性を出力します。

完成したフローは以下のようになります：

注意事項

1. CSV ファイルのカラム名は、挿入/更新/削除するデータソーステーブルのレコードのカラム名と一致する必要があります。

2. Apache NiFi バージョン1.9.0 より前のバージョンでは、PutDatabaseRecord プロセッサの Maximum Batch Size プロパティがサポートされていません。

設定

バッチINSERT、UPDATE、またはDELETE を実行するには、NiFi プロセッサを以下のように設定します：

1. ListFile プロセッサの設定：Input Directory プロパティを、CSV ファイルを取得するローカルフォルダパスに設定します。 File Filter プロパティを、名前が式に一致するファイルのみを選択する正規表現に設定します。 例：CSV ファイルのフルパスがC:\Users\Public\Documents\InsertNiFi.csv の場合、プロパティは以下の画像のように設定します：

2. FetchFile プロセッサの設定
FetchFile プロセッサのプロパティ設定はデフォルト値のままにします：
3. PutDatabaseRecord プロセッサの設定

INSERT 操作

バッチINSERT 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：


• Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
• Statement Type プロパティをINSERT に設定します。
• Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。

  プロパティ	値
  Database Connection URL	jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;
  Database Driver Class Name	cdata.jdbc.shopify.ShopifyDriver

• Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
• Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
• Table Name プロパティを、INSERT 先のテーブル名に設定します。
• Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。

UPDATE 操作

バッチUPDATE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

• Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
• Statement Type プロパティをUPDATE に設定します。
• Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
• Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
• Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
• Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
• Update Keys プロパティを、UPDATE に必要なカラム名に設定します。
• Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。

DELETE 操作

バッチDELETE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

• Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
• Statement Type プロパティをDELETE に設定します。
• Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
• Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
• Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
• Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
• INSERT やUPDATE のStatement Type とは異なり、DELETE 操作ではMaximum Batch Size プロパティは表示されません。ただし、操作は引き続きバッチで処理されます。変更しない場合、バッチあたりの最大レコード数はデフォルト値の2000 です。DELETE 操作で使用するMaximum Batch Size の値を変更するには、Statement Type をINSERT またはUPDATE に変更し、Maximum Batch Size プロパティの値を変更して「Apply Changes」をクリックします。最後に、プロセッサの設定を再度開き、Statement Type をDELETE に戻して「Apply Changes」をクリックします。

4. LogAttribute プロセッサの設定

   最後に、LogAttribute プロセッサを設定して、ユースケースに基づいてログに記録または無視する属性とログレベルを指定します。

無償トライアルと詳細情報

CData JDBC Driver for Shopify の30日間無償トライアルをダウンロードして、Apache NiFi でリアルタイムShopify のデータの操作をはじめましょう。ご不明な点があれば、サポートチームにお問い合わせください。