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

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

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

JDBC URL の生成

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

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

JDBC URL の作成をサポートするために、Jira Service Management JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからJAR ファイルを実行します。

		java -jar cdata.jdbc.jiraservicedesk.jar
	

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

Jira Service Management 接続プロパティの取得・設定方法

任意のJira Service Management Cloud またはJira Service Management Server インスタンスへの接続を確立できます。接続するにはURL プロパティを設定します。

• URL（例：https://yoursitename.atlassian.net）

カスタムフィールドへのアクセス

デフォルトでは、CData 製品はシステムフィールドのみを表示します。Issues のカスタムフィールドにアクセスするには、IncludeCustomFields を設定します。

Jira Service Management への認証

ベーシック認証

ローカルサーバーアカウントで認証するためには、次の接続プロパティを指定します。

• AuthScheme：Basic に設定。
• User：認証ユーザーのユーザー名に設定。
• Password：認証ユーザーのパスワードに設定。

API トークン

Cloud アカウントに接続するには、APIToken を取得する必要があります。API トークンを生成するには、Atlassian アカウントにログインして「API トークン」 -> 「API トークンの作成」をクリックします。生成されたトークンが表示されます。

データに接続するには以下を設定します。

• AuthScheme：APIToken に設定。
• User：認証ユーザーのユーザー名に設定。
• APIToken：作成したAPI トークンに設定。

ちなみに、Cloud アカウントへの接続でパスワード認証を使うことも可能ですが、非推奨となっています。

OAuth 2.0

Jira Service Management のOAuth 2.0 サポート（3LO）を活用して、ログインクレデンシャルなしでデータに接続することもできます。

この場合、AuthSchemeをすべてのOAuth フローでOAuth に設定する必要があります。また、すべてのシナリオでカスタムOAuth アプリケーションを作成して構成する必要があります。詳しくは、ヘルプドキュメントの「OAuth」セクションを参照してください。

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 プロセッサを以下のように設定します：

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

2. FetchFile プロセッサの設定
FetchFile プロセッサのプロパティ設定はデフォルト値のままにします：
3. 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:jiraservicedesk:ApiKey=myApiKey;User=MyUser;
  Database Driver Class Name	cdata.jdbc.jiraservicedesk.JiraServiceDeskDriver

• 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」をクリックします。

4. LogAttribute プロセッサの設定

   最後に、LogAttribute プロセッサを設定して、ユースケースに基づいてログに記録または無視する属性とログレベルを指定します。

無償トライアルと詳細情報

CData JDBC Driver for Jira Service Management の30日間無償トライアルをダウンロードして、Apache NiFi でリアルタイムJira Service Management のデータの操作をはじめましょう。ご不明な点があれば、サポートチームにお問い合わせください。