Smartsheet のデータをApache Kafka トピックにストリーミング
Apache Kafka は、主にリアルタイムデータパイプラインやイベント駆動型アプリケーションの構築に使用されるオープンソースのストリーム処理プラットフォームです。CData JDBC Driver for Smartsheetと組み合わせることで、Kafka はライブのSmartsheet のデータを扱うことができます。この記事では、Smartsheet データをApache Kafka トピックに接続、アクセス、ストリーミングする方法と、Confluent Control Center を起動してConfluent プラットフォームのKafka インフラストラクチャを使用して受信したSmartsheet のデータをユーザーが安全に管理および監視できるようにする方法について説明します。
CData JDBC Driver は最適化されたデータ処理機能を内蔵しており、ライブのSmartsheet のデータとのやり取りにおいて比類のないパフォーマンスを提供します。Smartsheet に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接Smartsheet にプッシュし、サポートされていない操作(多くの場合SQL 関数やJOIN 操作)については組み込みのSQL エンジンを使用してクライアント側で処理します。組み込みの動的メタデータクエリにより、ネイティブのデータ型を使用してSmartsheet のデータを操作および分析できます。
Smartsheet データ連携について
CData は、Smartsheet のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています:
- 添付ファイル、カラム、コメント、ディスカッションの読み取りと書き込みができます。
- 個々のセルのデータを表示したり、セルの履歴をレポートしたりできます。
- 添付ファイルの削除やダウンロード、シートの作成・コピー・削除・移動、行の別のシートへの移動やコピーなど、Smartsheet 固有のアクションを実行できます。
ユーザーは、Tableau、Crystal Reports、Excel などの分析ツールと Smartsheet を統合しています。また、当社のツールを活用して Smartsheet データをデータベースやデータウェアハウスにレプリケートしているお客様もいます。
はじめに
前提条件
Apache Kafka トピックでSmartsheet のデータをストリーミングするためにCData JDBC Driver を接続する前に、クライアントのLinux ベースのシステムに以下をインストールおよび設定してください。
- Confluent Platform for Apache Kafka
- Confluent Hub CLI のインストール
- Confluent Platform 用のSelf-Managed Kafka JDBC Source Connector
Smartsheet のデータへの新しいJDBC 接続を定義
- Linux ベースのシステムにCData JDBC Driver for Smartsheetをダウンロードします。
- 以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
- Smartsheet という名前の新しいディレクトリを作成します。
mkdir Smartsheet
- ダウンロードしたドライバーファイル(.zip)をこの新しいディレクトリに移動します。
mv SmartsheetJDBCDriver.zip Smartsheet/
- CData SmartsheetJDBCDriver の内容をこの新しいディレクトリに解凍します。
unzip SmartsheetJDBCDriver.zip
- Smartsheet という名前の新しいディレクトリを作成します。
- Smartsheet ディレクトリを開き、lib フォルダに移動します。
ls cd lib/
- CData JDBC Driver for Smartsheet のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.smartsheet.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
cp -r /path/to/CData JDBC Driver for Smartsheet/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/ cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
- 以下のコマンドを使用して、CData Smartsheet JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
java -jar cdata.jdbc.smartsheet.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 Smartsheet を使用して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_smartsheet_01", "config": { "connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector", "connection.url": "jdbc:smartsheet:OAuthClientId=MyOauthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;", "topic.prefix": "smartsheet-01-", "mode": "bulk" } }'HTTP POST 本文(上記)で使用されるフィールドについて説明します:
- connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
- connection.url: Smartsheet データに接続するためのJDBC 接続URL です。
組み込みの接続文字列デザイナー
JDBC URL の作成については、CData JDBC Driver for Smartsheetに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.smartsheet.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得する方法は次のとおりです。
- Smartsheet にログインします。
- 「アカウント」をクリックして「個人用の設定」を選択します。
- 「API アクセス」をクリックし、フォームを使用して新しいアクセストークンを生成するか、既存のアクセストークンを管理します。
その後、OAuthAccessToken を生成したトークンに設定します。
- topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「smartsheet-01-」に設定されています。
- mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。
このリクエストにより、Smartsheet のすべてのテーブル/コンテンツが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 Smartsheetの30日間無償トライアルをダウンロードして、Smartsheet データをApache Kafka にストリーミングしましょう。ご不明な点があれば、サポートチームまでお問い合わせください。