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

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

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

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

前提条件

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

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

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

  1. Linux ベースのシステムにCData JDBC Driver for BigCommerceをダウンロードします。
  2. 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
    1. BigCommerce という名前の新しいディレクトリを作成します。 
      		mkdir BigCommerce
    2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。 
      		mv BigCommerceJDBCDriver.zip BigCommerce/
    3. CData BigCommerceJDBCDriver の内容をこの新しいディレクトリに解凍します。 
      		unzip BigCommerceJDBCDriver.zip
  3. BigCommerce ディレクトリを開き、lib フォルダに移動します。 
    ls
cd lib/
  4. CData JDBC Driver for BigCommerce のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.bigcommerce.jar ファイルがlib フォルダに正常にコピーされたことを確認します。 
    cp -r /path/to/CData JDBC Driver for BigCommerce/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
  5. 以下のコマンドを使用して、CData BigCommerce JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。 
    	java -jar cdata.jdbc.bigcommerce.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 BigCommerce を使用して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_bigcommerce_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:bigcommerce:OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'",
		"topic.prefix": "bigcommerce-01-",
		"mode": "bulk"
		}
	}'

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

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

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

      JDBC URL の作成については、CData JDBC Driver for BigCommerceに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

      		java -jar cdata.jdbc.bigcommerce.jar

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

      BigCommerce 認証は標準のOAuth フローに基づいています。

      Store ID の取得

      BigCommerce Store に接続するには、StoreId が必要です。Store Id を確認するには、以下の手順に従ってください。

      1. BigCommerce アカウントにログインします。
      2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
      3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
      4. 画面にAPI Path という名前のテキストボックスが表示されます。
      5. テキストボックス内に、次の構造のURL が表示されます：https://api.bigcommerce.com/stores/{Store Id}/v3。
      6. 上記で示したように、Store Id は'stores/' と'/v3' パスパラメータの間にあります。
      7. Store Id を取得したら、「キャンセル」 をクリックするか、まだ持っていない場合はAPI Account の作成に進むことができます。

      パーソナルアクセストークンの取得

      加えて、自分のデータをテストおよびアクセスするには、個人用トークンを取得する必要があります。個人用トークンを取得する方法は次のとおりです。

      1. BigCommerce アカウントにログインします。
      2. ホームページから「Advanced Settings」->「API Accounts」 を選択します。
      3. 「Create API Account」->「Create V2/V3 API Token」をクリックします。
      4. アカウント名を入力します。
      5. 作成するAPI Account の「OAuth Scopes」を選択します。CData 製品 は"None" とマークされたデータにアクセスできません。また、"read-only" とマークされたデータを変更できません。
      6. 「保存」をクリックします。

      BigCommerce への認証

      次に、以下を設定してデータに接続できます。
      • StoreId：API Path テキストボックスから取得したStore ID に設定。
      • OAuthAccessToken：生成したトークンに設定。
      • InitiateOAuth：OFF に設定。
      組み込みの接続文字列デザイナーを使用してJDBC URL を生成（Salesforce の例）
    • topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「bigcommerce-01-」に設定されています。
    • mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。

    このリクエストにより、BigCommerce のすべてのテーブル/コンテンツが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 BigCommerceの30日間無償トライアルをダウンロードして、BigCommerce データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。

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

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

 ダウンロード

詳細：

BigCommerce Icon BigCommerce JDBC Driver お問い合わせ

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

この記事の内容

関連記事