Apache Airflow でau PAY Market のデータに連携したワークフローを作る

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

Apache Airflow を使うと、データエンジニアリングワークフローの作成、スケジューリング、および監視を行うことができます。CData JDBC Driver for auPAYMarket と組み合わせることで、Airflow からリアルタイムau PAY Market のデータに連携できます。 この記事では、Apache Airflow インスタンスからau PAY Market のデータに接続してクエリを実行し、結果をCSV ファイルに保存する方法を紹介します。

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

au PAY Market への接続を構成する

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

JDBC URL の作成の補助として、au PAY Market JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。

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

au PAY マーケットに接続するには、ShopId およびApiKey が必要です。

au PAY マーケットへのアクセスの設定

ShopId およびApiKey を取得するには、以下の手順に従ってください。

• Wow! manager サイトにログインして、「各種お申し込み」メニューの「API利用申請」に移動します。
• API利用規約に同意します。
• 「APIキーの発行はこちら」をクリックします。
• 「発行」ボタンをクリックして、API キーを生成します。
• 「接続元IPアドレスを登録」に、対象とするIP アドレスを入力します。
• 「登録」ボタンをクリックして、設定を保存します。

au PAY マーケットアカウントの認証

次の接続プロパティを設定して接続します。

• ShopId：接続先のau PAY マーケットShop ID を設定。
• ApiKey：API キーを設定。au PAY マーケットストアアカウントから取得したAPI キーです。
• UseSandbox：Sandbox 環境に接続する場合はTrue を設定。

クラスタ環境またはクラウドでJDBC ドライバーをホストするには、ライセンス（フルまたはトライアル）およびランタイムキー（RTK）が必要です。本ライセンス（またはトライアル）の取得については、こちらからお問い合わせください。

以下は、JDBC 接続で要求される必須プロパティです。

Airflow でJDBC 接続を確立する

1. Apache Airflow インスタンスにログインします。
2. Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。
3. 次の画面で「+」マークをクリックして新しい接続を作成します。
4. Add Connection フォームで、必要な接続プロパティを入力します。
   • Connection Id：接続の名前：aupaymarket_jdbc
   • Connection Type：JDBC Connection
   • Connection URL：上記のJDBC 接続URL：jdbc:aupaymarket:RTK=5246...;ApiKey=MyApiKey;ShopId=MyShopId
   • Driver Class：cdata.jdbc.aupaymarket.auPAYMarketDriver
   • Driver Path：PATH/TO/cdata.jdbc.aupaymarket.jar
   
5. フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
6. 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。

DAG を作成する

Airflow におけるDAG は、ワークフローのプロセスを格納するエンティティであり、DAG にトリガーを設定することでワークフローを実行することができます。 今回のワークフローでは、シンプルにau PAY Market のデータに対してSQL クエリを実行し、結果をCSV ファイルに格納します。

1. はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
2. 次に新しいPython ファイルを作成し、タイトルをau pay market_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="au pay market_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv'])
   
   		# Dag となる関数を定義（取得するテーブルは必要に応じて変更してください）
   		def extract_and_load():
   		# Define tasks
   			@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()
   	

3. このファイルを保存し、Airflow インスタンスをリフレッシュします。DAG リストの中に、「au pay market_hook」というタイトルの新しいDAG が表示されるはずです。
4. このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー（＝play）ボタンをクリックしてDAG を実行します。この操作で、au pay market_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。
5. 新規のDAG を実行後、Downloads フォルダ（またはPython スクリプト内で選択したフォルダ）を確認し、CSV ファイルが作成されていることを確認します（本ワークフローの場合はaccount.csv です）。
6. CSV ファイルを開くと、Apache Airflow によってau PAY Market のデータがCSV 形式で利用できるようになったことが確認できます。

詳細と無償トライアル