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

Dibyendu Datta
Lead Technology Evangelist

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

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

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

前提条件

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

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

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

Linux ベースのシステムにCData JDBC Driver for kintoneをダウンロードします。
以下の手順に従って新しいディレクトリを作成し、すべてのドライバーの内容を展開します:
1. Kintone という名前の新しいディレクトリを作成します。
```
		mkdir Kintone
		
```
2. ダウンロードしたドライバーファイル（.zip）をこの新しいディレクトリに移動します。
```
		mv KintoneJDBCDriver.zip Kintone/
		
```
3. CData KintoneJDBCDriver の内容をこの新しいディレクトリに解凍します。
```
		unzip KintoneJDBCDriver.zip
		
```
Kintone ディレクトリを開き、lib フォルダに移動します。
```
ls
cd lib/
```
CData JDBC Driver for kintone のlib フォルダの内容をKafka Connect JDBC のlib フォルダにコピーします。Kafka Connect JDBC フォルダの内容を確認し、cdata.jdbc.kintone.jar ファイルがlib フォルダに正常にコピーされたことを確認します。
```
cp -r /path/to/CData JDBC Driver for kintone/lib/* /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
cd /usr/share/confluent-hub-components/confluentinc-kafka-connect-jdbc/lib/
```
以下のコマンドを使用して、CData Kintone JDBC ドライバーのライセンスをインストールします。名前とメールアドレスを入力してください。
```
	java -jar cdata.jdbc.kintone.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 Kintone を使用して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_kintone_01",
		"config": {
			"connector.class": "io.confluent.connect.jdbc.JdbcSourceConnector",
			"connection.url": "jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;",
		"topic.prefix": "kintone-01-",
		"mode": "bulk"
		}
	}'
```
HTTP POST 本文（上記）で使用されるフィールドについて説明します:
- connector.class: 使用するKafka Connect コネクタのJava クラスを指定します。
- connection.url: Kintone データに接続するためのJDBC 接続URL です。
  組み込みの接続文字列デザイナー
  
  JDBC URL の作成については、CData JDBC Driver for kintoneに組み込まれた接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
```
		java -jar cdata.jdbc.kintone.jar
		
```
  接続プロパティを入力し、接続文字列をクリップボードにコピーします。
  
  Kintone 接続プロパティの設定方法
  
  それでは、Kintone に接続していきましょう。接続するには、以下の接続プロパティを設定します。
  - URL：Kintone のアクセスURL（例：https://yoursitename.cybozu.com または https://yoursitename.kintone.com）
  - User：アカウントのユーザー名
  - Password：アカウントのパスワード
  - AuthScheme：「Password」を指定
  パスワード認証の代わりにAPI トークン認証をご利用になる場合は、ヘルプドキュメントの「接続の設定」セクションをご確認ください。
  
  Basic 認証の設定
  
  続いて、ご利用のKintone ドメインでBasic 認証を有効にしている場合は、接続プロパティの「詳細」設定で以下の項目を追加設定してください。
  - BasicAuthUser：Basic 認証のユーザー名
  - BasicAuthPassword：Basic 認証のパスワード
  クライアント証明書認証の設定
  
  Basic 認証の代わりにクライアント証明書による認証をご利用になる場合は、以下の項目を設定してください。
  - SSLClientCert：クライアント証明書のパス
  - SSLClientCertType：証明書の種類
  - SSLClientCertSubject：証明書のサブジェクト
  - SSLClientCertPassword：証明書のパスワード
- topic.prefix: コネクタによって作成されるKafka トピックに追加されるプレフィックスです。「kintone-01-」に設定されています。
- mode: コネクタの動作モードを指定します。ここでは「bulk」に設定されており、コネクタがバルクデータ転送を実行するように設定されていることを示しています。
このリクエストにより、Kintone のすべてのテーブル/コンテンツが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/ と入力してください。