AWS Lambda でリアルタイムShopify のデータにアクセス
AWS Lambda は、新しい情報やイベントに素早く応答するアプリケーションを構築できるコンピューティングサービスです。CData JDBC Driver for Shopify と組み合わせることで、AWS Lambda 関数からリアルタイムShopify のデータを操作できます。この記事では、Eclipse で構築した AWS Lambda 関数からShopify のデータに接続してクエリを実行する方法を説明します。
なお、この記事の執筆時点(2022年6月)では、AWS Toolkit for Eclipse がサポートする最新バージョンは Eclipse 2019-12 および Java 8 となっています。
最適化されたデータ処理機能を組み込んだ CData JDBC ドライバは、リアルタイムShopify のデータとのインタラクションにおいて卓越したパフォーマンスを発揮します。Shopify に対して複雑な SQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされている SQL 操作を直接Shopifyにプッシュし、サポートされていない操作(主に SQL 関数や JOIN 操作)は組み込みの SQL エンジンを使用してクライアント側で処理します。さらに、動的メタデータクエリ機能により、ネイティブのデータ型を使用してShopify のデータの操作・分析が可能です。
接続プロパティの設定と接続文字列の構築
それでは、Shopify への接続・認証について説明していきましょう。Shopify では、アクセストークンとOAuth の2つの接続方法をサポートしています。
アクセストークンによる接続
アクセストークン経由の接続には、以下の2つのステップが必要です。
- Shopify の管理画面でアクセストークンを作成
- アクセストークンを使用して認証
アクセストークンの作成
まず、アプリを登録してアクセストークンを取得してみましょう。手順は以下のとおりです。
- 管理画面からShopify にログインし、Apps → Apps and sales channels に進みます
- Develop apps をクリックしてCreate an app を選択します
- Overview タブのConfiguration で、Admin API integration をクリックし、アプリに許可するストアのアクセス権を選択してください。CData製品が必要とするAdmin API 権限については、 href="/kb/help/" target="_blank">ヘルプドキュメントの「はじめに」セクションをご確認ください
- Save をクリックします
- Overview タブのConfiguration で、Storefront API integration をクリックし、アプリに許可するストアのアクセス権を選択します。CData製品が必要とするStorefront API 権限は以下のとおりです:
- unauthenticated_read_content
- Save をクリックします
- API Credentials を選択します
- "Access tokens" の下でInstall app をクリックします。これでアクセストークンが作成されます
- Admin API Access token のアクセストークンをコピーします。注意:トークンの公開およびコピーは1回のみ可能ですので、必ず保存してください
アクセストークンによる認証
続いて、アクセストークンで認証するには、以下のプロパティを設定してください。
- AuthScheme:AccessToken に設定
- AccessToken:カスタムアプリからコピーしたアクセストークンの値に設定
OAuth 認証を介した接続については、ヘルプドキュメントの「OAuth 認証の使用」をご確認ください。
NOTE: AWS Lambda 関数で JDBC ドライバーを使用するには、ライセンス(製品版または試用版)とランタイムキー(RTK)が必要です。ライセンス(または試用版)の取得については、弊社営業チームまでお問い合わせください。
組み込みの接続文字列デザイナー
JDBC URL の構築には、Shopify JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
java -jar cdata.jdbc.shopify.jar
接続プロパティ(RTK を含む)を入力し、接続文字列をクリップボードにコピーします。
AWS Lambda 関数の作成
- CData JDBC Driver for Shopify のインストーラーをダウンロードし、パッケージを解凍して JAR ファイルを実行してドライバーをインストールします。
AWS Toolkit for Eclipse を使用して、Eclipse で新しい AWS Lambda Java プロジェクトを作成します。詳細な手順は AWS のチュートリアル(amazon.com)を参照してください。
この記事では、テーブル名を入力として渡せるように、プロジェクトのInput Type を「Custom」に設定します。
- CData JDBC Driver for Shopify の JAR ファイル(cdata.jdbc.shopify.jar)をビルドパスに追加します。このファイルは INSTALL_PATH\lib\ にあります。
- Java クラスに以下の import 文を追加します。
import java.sql.Connection; import java.sql.DriverManager; import java.sql.ResultSet; import java.sql.ResultSetMetaData; import java.sql.SQLException; import java.sql.Statement;
handleRequest メソッドの本体を以下のコードに置き換えます。DriverManager.getConnection メソッド呼び出し内の接続文字列は、実際の値に置き換えてください。
String query = "SELECT * FROM " + input; try { Class.forName("cdata.jdbc.shopify.ShopifyDriver"); } catch (ClassNotFoundException ex) { context.getLogger().log("Error: class not found"); } Connection connection = null; try { connection = DriverManager.getConnection("jdbc:cdata:shopify:RTK=52465...;AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;"); } catch (SQLException ex) { context.getLogger().log("Error getting connection: " + ex.getMessage()); } catch (Exception ex) { context.getLogger().log("Error: " + ex.getMessage()); } if(connection != null) { context.getLogger().log("Connected Successfully!\n"); } ResultSet resultSet = null; try { //executing query Statement stmt = connection.createStatement(); resultSet = stmt.executeQuery(query); ResultSetMetaData metaData = resultSet.getMetaData(); int numCols = metaData.getColumnCount(); //printing the results while(resultSet.next()) { for(int i = 1; i <= numCols; i++) { System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null ); } System.out.print("\n"); } } catch (SQLException ex) { System.out.println("SQL Exception: " + ex.getMessage()); } catch (Exception ex) { System.out.println("General exception: " + ex.getMessage()); } String output = "query: " + query + " complete"; return output;
Lambda 関数のデプロイと実行
Eclipse で関数をビルドしたら、アップロードして実行する準備が整います。この記事では出力を AWS ログに書き込んでいますが、これをテンプレートとして、AWS Lambda 関数でShopify のデータを操作する独自のカスタムビジネスロジックを実装できます。
- パッケージを右クリックして、Amazon Web Services -> Upload function to AWS Lambda を選択します。
- 関数に名前を付け、IAM ロールを選択し、タイムアウト値を関数が完了するのに十分な値に設定します(クエリの結果サイズによって異なります)。
- パッケージを右クリックして、Amazon Web Services -> Run function on AWS Lambda を選択し、クエリ対象のShopifyオブジェクト名(例:「Customers」)を入力します。
- ジョブの実行後、CloudWatch ログで出力を確認できます。
無償トライアル・詳細情報
CData JDBC Driver for Shopify の30日間の無償トライアルをダウンロードして、AWS Lambda でリアルタイムShopify のデータを活用してみてください。ご不明な点があれば、サポートチームまでお気軽にお問い合わせください。