Apache Airflow で au PAY Market データを連携
Apache Airflow は、データエンジニアリングワークフローの作成、スケジューリング、モニタリングをサポートするツールです。 CData JDBC Driver for au PAY Market と組み合わせることで、Airflow からリアルタイムの au PAY Market のデータ を扱うことができます。 この記事では、Apache Airflow インスタンスから au PAY Market のデータ に接続してクエリを実行し、結果を CSV ファイルに保存する方法を説明します。
CData JDBC ドライバーは、最適化されたデータ処理機能を組み込んでおり、 リアルタイムの au PAY Market のデータ を扱う際に比類のないパフォーマンスを発揮します。複雑な SQL クエリを 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 ファイルを実行してください。
java -jar cdata.jdbc.aupaymarket.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 接続に必要な主なプロパティです。
| プロパティ | 値 |
|---|---|
| データベース接続 URL | jdbc:aupaymarket:RTK=5246...;ApiKey=MyApiKey;ShopId=MyShopId |
| データベースドライバークラス名 | cdata.jdbc.aupaymarket.auPAYMarketDriver |
Airflow で JDBC 接続を設定
- Apache Airflow インスタンスにログインします。
- Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
- 次の画面で + ボタンをクリックして、新しい接続を作成します。
- 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
- フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
- 新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。
DAG の作成
Airflow の DAG は、ワークフローのプロセスを保存し、トリガーすることでワークフローを実行できるエンティティです。 ここでのワークフローは、au PAY Market のデータ に対して SQL クエリを実行し、結果を CSV ファイルに保存するというシンプルなものです。
- まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。 ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。
- 次に、新しい 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(): # タスクを定義 @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 のリストに「au pay market_hook」という新しい DAG が表示されるはずです。
- この DAG をクリックし、次の画面で一時停止スイッチをクリックして青色にオンにします。次に、トリガー(再生)ボタンをクリックして DAG を実行します。これにより、au pay market_hook.py ファイル内の SQL クエリが実行され、コード内で指定したファイルパスに CSV として結果がエクスポートされます。
- 新しい DAG をトリガーした後、Downloads フォルダ(または Python スクリプト内で指定した場所)を確認すると、CSV ファイルが作成されていることがわかります。この例では account.csv です。
- CSV ファイルを開くと、Apache Airflow によって au PAY Market のデータ が CSV 形式で利用可能になっていることを確認できます。