Apache Airflow で AlloyDB データを連携
Apache Airflow は、データエンジニアリングワークフローの作成、スケジューリング、モニタリングをサポートするツールです。 CData JDBC Driver for AlloyDB と組み合わせることで、Airflow からリアルタイムの AlloyDB のデータ を扱うことができます。 この記事では、Apache Airflow インスタンスから AlloyDB のデータ に接続してクエリを実行し、結果を CSV ファイルに保存する方法を説明します。
CData JDBC ドライバーは、最適化されたデータ処理機能を組み込んでおり、 リアルタイムの AlloyDB のデータ を扱う際に比類のないパフォーマンスを発揮します。複雑な SQL クエリを AlloyDB に発行すると、 ドライバーはフィルタや集計などのサポートされている SQL 操作を直接 AlloyDB にプッシュし、 サポートされていない操作(主に SQL 関数や JOIN 操作)は組み込みの SQL エンジンを使用してクライアント側で処理します。 また、組み込みの動的メタデータクエリ機能により、ネイティブのデータ型を使用して AlloyDB のデータ の操作・分析が可能です。
AlloyDB への接続を設定
組み込みの接続文字列デザイナー
JDBC URL の構築には、AlloyDB JDBC Driver に組み込まれている接続文字列デザイナーを使用できます。JAR ファイルをダブルクリックするか、コマンドラインから JAR ファイルを実行してください。
java -jar cdata.jdbc.alloydb.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
AlloyDB 接続プロパティの取得・設定方法
AlloyDB に接続するには、次の接続プロパティが必要です。
- Server:AlloyDB データベースをホスティングしているサーバーのホスト名またはIP アドレス。
- Port(オプション):AlloyDB データベースをホスティングしているサーバーのポート。このプロパティはデフォルトで5432に設定されます。
- User:AlloyDB サーバーに認証する際に使われるユーザー。
- Password:AlloyDB サーバーに認証する際に使われるパスワード。
- Database(オプション):AlloyDB サーバーに接続する場合のデータベース。設定されていない場合は、ユーザーのデフォルトデータベースが使用されます。
AlloyDB への認証
標準認証
標準認証(事前に提供されたユーザーとパスワードの組み合わせを使用)は、デフォルトの認証形式です。標準認証で接続する場合は、これ以上のアクションは必要ありません。
pg_hba.conf 認証スキーム
CData 製品がサポートしている他の認証方法では、AlloyDB サーバー上のpg_hba.conf ファイルで有効化する必要があります。
AlloyDB サーバーでの認証の設定については、こちらを参照してください。
MD5
pg_hba.conf ファイルのauth-method をmd5 に設定すると、MD5 パスワード検証を使用して認証できます。
SASL
CData 製品は、SASL(特にSCRAM-SHA-256)でパスワードを検証することで認証できます。
この認証方法を使用するには、pg_hba.conf ファイルのauth-method をscram-sha-256 に設定します。
Kerberos
Kerberos 認証は、CData 製品が接続を試行している際にAlloyDB サーバーで開始されます。この認証方法を有効化するには、AlloyDB
サーバーでKerberos を設定します。AlloyDB サーバーでのKerberos 認証の設定を完了したら、CData 製品からKerberos
認証を行う方法については、ヘルプドキュメントの「Kerberos
の使用」セクションを参照してください。
クラスター環境やクラウドで JDBC ドライバーをホストする場合は、ライセンス(製品版またはトライアル版)とランタイムキー(RTK)が必要です。ライセンス(またはトライアル)の取得については、弊社営業チームにお問い合わせください。
以下は、JDBC 接続に必要な主なプロパティです。
| プロパティ | 値 |
|---|---|
| データベース接続 URL | jdbc:alloydb:RTK=5246...;User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432 |
| データベースドライバークラス名 | cdata.jdbc.alloydb.AlloyDBDriver |
Airflow で JDBC 接続を設定
- Apache Airflow インスタンスにログインします。
- Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
- 次の画面で + ボタンをクリックして、新しい接続を作成します。
- Add Connection フォームで、必要な接続プロパティを入力します:
- Connection Id:接続の名前を入力します(例:alloydb_jdbc)
- Connection Type:JDBC Connection
- Connection URL:上記の JDBC 接続 URL(例:jdbc:alloydb:RTK=5246...;User=alloydb;Password=admin;Database=alloydb;Server=127.0.0.1;Port=5432)
- Driver Class:cdata.jdbc.alloydb.AlloyDBDriver
- Driver Path:PATH/TO/cdata.jdbc.alloydb.jar
- フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
- 新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。
DAG の作成
Airflow の DAG は、ワークフローのプロセスを保存し、トリガーすることでワークフローを実行できるエンティティです。 ここでのワークフローは、AlloyDB のデータ に対して SQL クエリを実行し、結果を CSV ファイルに保存するというシンプルなものです。
- まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。 ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。
- 次に、新しい Python ファイルを作成し、alloydb_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="alloydb_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 のリストに「alloydb_hook」という新しい DAG が表示されるはずです。
- この DAG をクリックし、次の画面で一時停止スイッチをクリックして青色にオンにします。次に、トリガー(再生)ボタンをクリックして DAG を実行します。これにより、alloydb_hook.py ファイル内の SQL クエリが実行され、コード内で指定したファイルパスに CSV として結果がエクスポートされます。
- 新しい DAG をトリガーした後、Downloads フォルダ(または Python スクリプト内で指定した場所)を確認すると、CSV ファイルが作成されていることがわかります。この例では account.csv です。
- CSV ファイルを開くと、Apache Airflow によって AlloyDB のデータ が CSV 形式で利用可能になっていることを確認できます。