Apache NiFi でKintone のデータにバッチ操作を実行

Jerod Johnson
Senior Technology Evangelist

CData JDBC Driver を使用して、Apache NiFi でKintone のデータに接続してバッチ操作を実行。

Apache NiFi は、データルーティング、変換、およびシステム間連携ロジックを強力かつスケーラブルに構築できるプラットフォームです。CData JDBC Driver for Kintone と組み合わせることで、NiFi からリアルタイムKintone のデータを操作できるようになります。この記事では、CSV ファイルからデータを読み取り、Apache NiFi（バージョン1.9.0 以降）でCData JDBC Driver forKintone のデータを使用してバッチ操作（INSERT/UPDATE/DELETE）を実行する方法を説明します。

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

JDBC URL の生成

Apache NiFi からKintone のデータに接続するには、JDBC URL が必要です。

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

JDBC URL の作成をサポートするために、Kintone JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。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：証明書のパスワード

組み込みの接続文字列デザイナーを使ってJDBC URL を生成（Salesforce の場合）

Apache NiFi でのバッチ操作（INSERT/UPDATE/DELETE）

以下のサンプルフローは、次のNiFi プロセッサに基づいています：

ListFile - ローカルファイルシステムからファイルリストを取得し、取得した各ファイルにFlowFile を作成します。
FetchFile - ListFile プロセッサから受け取ったFlowFile のコンテンツを読み取ります。
PutDatabaseRecord - 指定されたRecordReader を使用して、FetchFile プロセッサからのフローファイルからレコードを入力します。これらのレコードはSQL 文に変換され、単一のトランザクションとして実行されます。
LogAttribute - 指定されたログレベルでFlowFile の属性を出力します。

完成したフローは以下のようになります：

注意事項

1. CSV ファイルのカラム名は、挿入/更新/削除するデータソーステーブルのレコードのカラム名と一致する必要があります。

2. Apache NiFi バージョン1.9.0 より前のバージョンでは、PutDatabaseRecord プロセッサの Maximum Batch Size プロパティがサポートされていません。

設定

バッチINSERT、UPDATE、またはDELETE を実行するには、NiFi プロセッサを以下のように設定します：

ListFile プロセッサの設定：Input Directory プロパティを、CSV ファイルを取得するローカルフォルダパスに設定します。 File Filter プロパティを、名前が式に一致するファイルのみを選択する正規表現に設定します。例：CSV ファイルのフルパスがC:\Users\Public\Documents\InsertNiFi.csv の場合、プロパティは以下の画像のように設定します：

FetchFile プロセッサの設定

PutDatabaseRecord プロセッサの設定

INSERT 操作

バッチINSERT 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
Statement Type プロパティをINSERT に設定します。

Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。

プロパティ	値
Database Connection URL	jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;
Database Driver Class Name	cdata.jdbc.kintone.KintoneDriver

Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
Table Name プロパティを、INSERT 先のテーブル名に設定します。
Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。

UPDATE 操作

バッチUPDATE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
Statement Type プロパティをUPDATE に設定します。
Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
Update Keys プロパティを、UPDATE に必要なカラム名に設定します。
Maximum Batch Size プロパティを、単一のバッチに含めるレコードの最大数に設定します。

DELETE 操作

バッチDELETE 操作を実行するには、PutDatabaseRecord プロセッサを以下のように設定します：

Record Reader プロパティをCSV Reader Controller Service に設定します。CSV Reader Controller Service を、CSV ファイルの形式に合わせて設定します。
Statement Type プロパティをDELETE に設定します。
Database Connection Pooling Service を、ドライバー設定を保持するDBCPConnection Pool に設定します。ドライバーはBulk API を使用するように設定する必要があります。上記と同じDatabase Connection URL 形式を使用します。
Catalog Name プロパティを、テーブルが属するカタログの名前に設定します。
Schema Name プロパティを、テーブルが属するスキーマの名前に設定します。
Table Name プロパティを、UPDATE 対象のテーブル名に設定します。
INSERT やUPDATE のStatement Type とは異なり、DELETE 操作ではMaximum Batch Size プロパティは表示されません。ただし、操作は引き続きバッチで処理されます。変更しない場合、バッチあたりの最大レコード数はデフォルト値の2000 です。DELETE 操作で使用するMaximum Batch Size の値を変更するには、Statement Type をINSERT またはUPDATE に変更し、Maximum Batch Size プロパティの値を変更して「Apply Changes」をクリックします。最後に、プロセッサの設定を再度開き、Statement Type をDELETE に戻して「Apply Changes」をクリックします。