Apache Airflow で Confluence データを連携

Jerod Johnson
Senior Technology Evangelist

CData JDBC Driver を使用して、Apache Airflow で Confluence のデータにアクセスして処理。

Apache Airflow は、データエンジニアリングワークフローの作成、スケジューリング、モニタリングをサポートするツールです。 CData JDBC Driver for Confluence と組み合わせることで、Airflow からリアルタイムの Confluence のデータを扱うことができます。この記事では、Apache Airflow インスタンスから Confluence のデータに接続してクエリを実行し、結果を CSV ファイルに保存する方法を説明します。

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

Confluence への接続を設定

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

JDBC URL の構築には、Confluence JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。

java -jar cdata.jdbc.confluence.jar

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

Confluence 接続プロパティの取得・設定方法

任意のConfluence Cloud またはConfluence Server インスタンスへの接続を確立できます。接続するにはURL 接続プロパティを設定します。例えば、https://yoursitename.atlassian.net です。

Confluence への認証

Confluence は、次の認証メソッドをサポートしています：API トークン、Basic 認証、OAuth 2.0、SSO。

API トークン - Confluence Cloud アカウント

トークンの取得

アカウント認証にはAPI トークンが必要です。API トークンを生成するには、Atlassian アカウントにログインしてAPI トークン -> API トークンの作成を選択します。生成されたトークンが表示されます。

トークンを使用する認証

Cloud アカウントへの認証を行うには、以下を入力します。

AuthScheme：APIToken に設定。
User：Confluence サーバーに認証する際に使用されるユーザー。
APIToken：現在認証されているユーザーに紐づくAPI トークン。
Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

Basic 認証 - Confluence Server インスタンス

Server インスタンスへの認証を行うには、以下のように指定します。

AuthScheme：Basic に設定。
User：Confluence インスタンスに認証する際に使用されるユーザー。
Password：Confluence サーバーに認証する際に使われるパスワード。
Url：Confluence エンドポイントに紐づくURL。例えば、https://yoursitename.atlassian.net です。

その他の認証方法と詳細については、ヘルプドキュメントの「はじめに」セクションを参照してください。組み込みの接続文字列デザイナーを使用して JDBC URL を生成（confluence を表示）

クラスター環境やクラウドで JDBC ドライバーをホストする場合は、ライセンス（製品版またはトライアル版）とランタイムキー（RTK）が必要です。ライセンス（またはトライアル）の取得については、弊社営業チームにお問い合わせください。

以下は、JDBC 接続に必要な主なプロパティです。

プロパティ	値
データベース接続 URL	jdbc:confluence:RTK=5246...;User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;
データベースドライバークラス名	cdata.jdbc.confluence.ConfluenceDriver

Airflow で JDBC 接続を設定

Apache Airflow インスタンスにログインします。
Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
次の画面で + ボタンをクリックして、新しい接続を作成します。
Add Connection フォームで、必要な接続プロパティを入力します：
- Connection Id：接続の名前を入力します（例：confluence_jdbc）
- Connection Type：JDBC Connection
- Connection URL：上記の JDBC 接続 URL（例：jdbc:confluence:RTK=5246...;User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;)
- Driver Class：cdata.jdbc.confluence.ConfluenceDriver
- Driver Path：PATH/TO/cdata.jdbc.confluence.jar
フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。

DAG の作成

Airflow の DAG は、ワークフローのプロセスを保存し、トリガーすることでワークフローを実行できるエンティティです。ここでのワークフローは、Confluence のデータに対して SQL クエリを実行し、結果を CSV ファイルに保存するというシンプルなものです。

まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。

次に、新しい Python ファイルを作成し、confluence_hook.py という名前を付けます。このファイルに以下のコードを挿入してください：

	import time
	from datetime import datetime
	from airflow.decorators import dag, task
	from airflow.providers.jdbc.hooks.jdbc import JdbcHook
	import pandas as pd

	# DAG を宣言
	@dag(dag_id="confluence_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv'])

	# DAG 関数を定義
	def extract_and_load():
	# タスクを定義
		@task()
		def jdbc_extract():
			try:
				hook = JdbcHook(jdbc_conn_id="jdbc")
				sql = """ select * from Account """
				df = hook.get_pandas_df(sql)
				df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1)
				# print(df.head())
				print(df)
				tbl_dict = df.to_dict('dict')
				return tbl_dict
			except Exception as e:
				print("Data extract error: " + str(e))

		jdbc_extract()

	sf_extract_and_load = extract_and_load()

このファイルを保存し、Airflow インスタンスを更新します。DAG のリストに「confluence_hook」という新しい DAG が表示されるはずです。
この DAG をクリックし、次の画面で一時停止スイッチをクリックして青色にオンにします。次に、トリガー（再生）ボタンをクリックして DAG を実行します。これにより、confluence_hook.py ファイル内の SQL クエリが実行され、コード内で指定したファイルパスに CSV として結果がエクスポートされます。
新しい DAG をトリガーした後、Downloads フォルダ（または Python スクリプト内で指定した場所）を確認すると、CSV ファイルが作成されていることがわかります。この例では account.csv です。
CSV ファイルを開くと、Apache Airflow によって Confluence のデータが CSV 形式で利用可能になっていることを確認できます。