Apache Airflow で SQL Server データを連携

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

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

SQL Server への接続を設定

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

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

java -jar cdata.jdbc.sql.jar

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

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

Microsoft SQL Server への接続には以下を入力します。

• Server: SQL Server が稼働するサーバー名。
• User: SQL Server に接続するユーザー名。
• Password: 接続するユーザーのパスワード。
• Database: SQL Server データベース名。

Azure SQL Server およびAzure Data Warehouse への接続

Azure SQL Server およびAzure Data Warehouse には以下の接続プロパティを入力して接続します:

• Server: Azure 上のサーバー。Azure ポータルの「SQL databases」（もしくは「SQL data warehouses」）-> データベースを選択 -> 「Overview」-> 「Server name」で確認が可能です。
• User: Azure に認証するユーザー名。
• Password: 認証するユーザーのパスワード。
• Database: Azure ポータルでSQL databases (or SQL warehouses) ページに表示されるデータベース名。

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

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

Airflow で JDBC 接続を設定

1. Apache Airflow インスタンスにログインします。
2. Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
3. 次の画面で + ボタンをクリックして、新しい接続を作成します。
4. Add Connection フォームで、必要な接続プロパティを入力します：
   • Connection Id：接続の名前を入力します（例：sql_jdbc）
   • Connection Type：JDBC Connection
   • Connection URL：上記の JDBC 接続 URL（例：jdbc:sql:RTK=5246...;User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=1433;)
   • Driver Class：cdata.jdbc.sql.SQLDriver
   • Driver Path：PATH/TO/cdata.jdbc.sql.jar
   
5. フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
6. 新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。

DAG の作成

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

1. まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。 ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。
2. 次に、新しい Python ファイルを作成し、sql server_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="sql server_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()
   

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

詳細情報と無料トライアル