ShipStation のデータをApache Kafka トピックにストリーミング
Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for ShipStationと組み合わせることで、Kafka はライブのShipStation のデータを扱うことができます。この記事では、ShipStation データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したShipStation のデータをユーザーが安全に管理および監視できるようにする方法について説明します。
CData JDBC Driver は最適化されたデータ処理機能を内蔵しており、ライブのShipStation のデータとのやり取りにおいて比類のないパフォーマンスを提供します。ShipStation に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接ShipStation にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)については組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してShipStation のデータを操作および分析できます。
前提条件
Apache Kafka トピックでShipStation のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。
- Confluent Platform for Apache Kafka
- Confluent Hub CLI のインストール
- Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector
ShipStation のデータへの新しいJDBC 接続を定義
- Linux ベースのシステムにCData JDBC Driver for ShipStationをダウンロードします。
- 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
- ShipStation という名前の新しいディレクトリを作成します。
mkdir ShipStation
- ダウンロードしたドライバーファイル(.zip)をこの新しいディレクトリに移動します。
mv ShipStationJDBCDriver.zip ShipStation/
- CData ShipStationJDBCDriver の内容をこの新しいディレクトリに解凍します。
unzip ShipStationJDBCDriver.zip
- ShipStation という名前の新しいディレクトリを作成します。
- ShipStation ディレクトリを開き、lib フォルダに移動します。
ls cd lib/
- CData JDBC Driver for ShipStation のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.shipstation.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
cp -r /path/to/CData JDBC Driver for ShipStation/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/ cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
- 以下のコマンドを使用して、CData ShipStation JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
java -jar cdata.jdbc.shipstation.jar -l
- プロダクトキーまたは"TRIAL" を入力します(ライセンスの有効期限が切れた場合は、CData サポートチームまでお問い合わせください)。
- 以下のコマンドを使用してConfluent ローカルサービスを起動します:
confluent local services start
これにより、Zookeeper、Kafka、Schema Registry、Kafka REST、Kafka CONNECT、ksqlDB、Control Center などのすべてのConfluent サービスが起動します。これで、CData JDBC Driver for ShipStation を使用してKafka Connect Driver 経由でksqlDB のKafka トピックにメッセージをストリーミングする準備が整いました。
- POST HTTP API リクエストを使用してKafka トピックを手動で作成します:
curl --location 'server_address:8083/connectors' --header 'Content-Type: application/json' --data '{ "name": "jdbc_source_cdata_shipstation_01", "config": { "connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", "connection.url": "jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'", "topic.prefix": "shipstation-01-", "mode": "bulk" } }'HTTP POST 本文(上記)で使用されるフィールドについて説明します:
- connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
- connection.url: ShipStation データに接続するためのJDBC 接続URL です。
組み込みの接続文字列デザイナー
JDBC URL の作成については、CData JDBC Driver for ShipStationに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.shipstation.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
ShipStation 接続プロパティの取得・設定方法
ShipStation への接続には、BASIC 認証標準を使います。
- ShipStation アカウントにログインします。
- 右上隅にある[設定]アイコンをクリックします。左側にカラムメニューが表示されます。
- [アカウント]->[API 設定]をクリックします。
- [API 設定]ページで、API Key とAPI Secret を書き留めます。
ShipStation への認証
- APIKey:[API 設定]ページのAPI Key に設定します。
- APISecret:[API 設定]ページのSecret key に設定します。
- topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「shipstation-01-」に設定されています。
- mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。
このリクエストにより、ShipStation のすべてのテーブル/コンテンツがKafka トピックとして追加されます。
注意: リクエストをPOST するIP アドレス(サーバー)は、Linux ネットワークのIP アドレスです。
- ksqlDB を実行し、トピックを一覧表示します。以下のコマンドを使用します:
ksql list topics;
- トピック内のデータを表示するには、以下のSQL ステートメントを入力します:
PRINT topic FROM BEGINNING;
Confluent Control Center への接続
Confluent Control Center のユーザーインターフェースにアクセスするには、上記のセクションで説明した"confluent local services" を実行し、ローカルブラウザでhttp://<server address>:9021/clusters/ と入力してください。
おわりに
CData JDBC Driver for ShipStationの30日間無償トライアルをダウンロードして、ShipStation データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。