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