Shopify のデータをApache Kafka トピックにストリーミング

Dibyendu Datta
Dibyendu Datta
Lead Technology Evangelist
CData JDBC Driver とKafka Connect JDBC コネクタを使用して、Apache Kafka でShopify のデータにアクセスし、ストリーミングできます。

Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for Shopifyと組み合わせることで、Kafka はライブのShopify のデータを扱うことができます。この記事では、Shopify データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したShopify のデータをユーザーが安全に管理および監視できるようにする方法について説明します。

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

前提条件

Apache Kafka トピックでShopify のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。

  1. Confluent Platform for Apache Kafka
  2. Confluent Hub CLI のインストール
  3. Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector

Shopify のデータへの新しいJDBC 接続を定義

  1. Linux ベースのシステムにCData JDBC Driver for Shopifyをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. Shopify という名前の新しいディレクトリを作成します。 
      		mkdir Shopify
    2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。 
      		mv ShopifyJDBCDriver.zip Shopify/
    3. CData ShopifyJDBCDriver の内容をこの新しいディレクトリに解凍します。 
      		unzip ShopifyJDBCDriver.zip
  3. Shopify ディレクトリを開き、lib フォルダに移動します。 
    ls
cd lib/
  4. CData JDBC Driver for Shopify のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.shopify.jar ファイルがlib フォルダに正常にコピーされたことを確認します。 
    cp -r /path/to/CData JDBC Driver for Shopify/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. 以下のコマンドを使用して、CData Shopify JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。 
    	java -jar cdata.jdbc.shopify.jar -l
  6. プロダクトキーまたは"TRIAL" を入力します（ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください）。
  7. 以下のコマンドを使用してConfluent ローカルサービスを起動します: 
    	confluent local services start

    これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for Shopify を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。

    Confluent ローカルサービスを起動
  8. POST HTTP API リクエストを使用してKafka トピックを手動で作成します: 
     curl --location 'server_address:8083/connectors'
	--header 'Content-Type: application/json'
	--data '{
		"name": "jdbc_source_cdata_shopify_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:shopify:AppId=MyAppId;Password=MyPassword;ShopUrl=https://yourshopname.myshopify.com;",
		"topic.prefix": "shopify-01-",
		"mode": "bulk"
		}
	}'

    HTTP POST 本文（上記）で使用されるフィールドについて説明します:

    • connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
    • connection.url: Shopify データに接続するためのJDBC 接続URL です。

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

      JDBC URL の作成については、CData JDBC Driver for Shopifyに組み込まれた接続文字列デザイナーを使用してください。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 認証の使用」をご確認ください。

      組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）
    • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「shopify-01-」に設定されています。
    • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

    このリクエストにより、Shopify のすべてのテーブル/コンテンツがKafka トピックとして追加されます。

    注意: リクエストをPOST するIP アドレス（サーバー）は、Linux ネットワークのIP アドレスです。

  9. ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します: 
    ksql
list topics;
    Kafka トピックを一覧表示（BigCommerce の例）
  10. トピック内のデータを表示するには、以下のSQL ステートメントを入力します: 
    PRINT topic FROM BEGINNING;

Confluent Control Center への接続

Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。

Confluent Control Center に接続

おわりに

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

はじめる準備はできましたか？

Shopify Driver の無料トライアルをダウンロードしてお試しください：

 ダウンロード

詳細：

Shopify Icon Shopify JDBC Driver お問い合わせ

Shopify EC データに連携するJava アプリケーションを素早く、簡単に開発できる便利なドライバー。

この記事の内容

関連記事