Apache Airflow で SharePoint Excel Services データを連携

Jerod Johnson
Senior Technology Evangelist

CData JDBC Driver を使用して、Apache Airflow で SharePoint Excel Services のデータにアクセスして処理。

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

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

SharePoint Excel Services への接続を設定

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

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

java -jar cdata.jdbc.excelservices.jar

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

ワークブックへの接続

どちらのSharePoint エディションをお使いでも、File を Excel ワークブックに設定してください。このパスは以下のプロパティからの相対パスになります。

Library：デフォルトではShared Documents ライブラリが使用されます。このプロパティを使って、組織内の別のドキュメントライブラリを指定してみてください。例えば、OneDrive for Business に接続する場合は、このプロパティを"Documents" に設定します。
Folder：このプロパティを使って、ライブラリ内のサブフォルダへのパスを指定できます。パスはLibrary で指定されたライブラリ名に関連します。

テーブルとしてのスプレッドシートデータへの接続

CData 製品では、基底API で利用可能なオブジェクトに基づいて、使用可能なテーブルを検出していきます。

API では異なるAPI オブジェクトを表示します。スプレッドシートの構成とSharePoint のバージョンに基づいてAPI を選択しましょう。

OData： OData API を使用すると、Excel で［挿入］->［テーブル］をクリックして作成されたExcel テーブルオブジェクト（範囲やスプレッドシートではありません）から定義されたテーブルにアクセスできます。OData API に接続する際、ワークブックにテーブルオブジェクトが定義されていない場合は、CData 製品がテーブルを返さないことがあります。テーブルとしてスプレッドシートまたは範囲に接続するには、UseRESTAPI をtrue に設定してください。
REST： REST API を使用すると、Excel テーブルオブジェクト、範囲、およびスプレッドシートから定義されたテーブルへアクセスできます。これがデフォルトの API です。範囲およびスプレッドシートから多数の行をリクエストすることは REST API によって制限されており、CData 製品では返される行数をデフォルトで 100 に制限しています。また CData 製品では、デフォルトで1行目からカラム名を検出します。これを無効にするには、Header を設定してください。

DefineTables を追加設定すると、Excel の範囲の構文を使用して、範囲に基づいてテーブルを定義できます。大きすぎる範囲は、API によって制限されます。

SharePoint オンプレミスへの接続

URL をサーバー名もしくはIP アドレスに設定しましょう。さらに、SharePointVersion と認証値を設定します。

SharePoint OnPremises を認証するには、AuthScheme を認証タイプに設定し、必要に応じてUser と Password を設定してください。

Note：SharePoint On-Premises 2010 に接続する場合は、 UseRESTAPI をtrue に設定する必要があります。

Windows（NTLM）

最も一般的な認証タイプです。CData 製品では NTLM をデフォルトとして使用するよう事前設定されています。Windows のUser と Password を設定して接続してください。

その他の認証方法については、ヘルプドキュメントの「はじめに」をご覧ください。

組み込みの接続文字列デザイナーを使用して JDBC URL を生成（sharepoint excel services を表示）

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

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

プロパティ	値
データベース接続 URL	jdbc:excelservices:RTK=5246...;URL=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;
データベースドライバークラス名	cdata.jdbc.excelservices.ExcelServicesDriver

Airflow で JDBC 接続を設定

Apache Airflow インスタンスにログインします。
Airflow インスタンスのナビゲーションバーで、Admin にカーソルを合わせ、Connections をクリックします。
次の画面で + ボタンをクリックして、新しい接続を作成します。
Add Connection フォームで、必要な接続プロパティを入力します：
- Connection Id：接続の名前を入力します（例：excelservices_jdbc）
- Connection Type：JDBC Connection
- Connection URL：上記の JDBC 接続 URL（例：jdbc:excelservices:RTK=5246...;URL=https://myorg.sharepoint.com;User=admin@myorg.onmicrosoft.com;Password=password;File=Book1.xlsx;)
- Driver Class：cdata.jdbc.excelservices.ExcelServicesDriver
- Driver Path：PATH/TO/cdata.jdbc.excelservices.jar
フォーム下部の Test ボタンをクリックして、新しい接続をテストします。
新しい接続を保存すると、次の画面で接続リストに新しい行が追加されたことを示す緑色のバナーが表示されます。

DAG の作成

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

まず、ホームディレクトリに「airflow」フォルダがあるはずです。その中に「dags」という新しいディレクトリを作成します。ここに Python ファイルを保存すると、UI 上で Airflow DAG として表示されます。

次に、新しい Python ファイルを作成し、sharepoint excel services_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="sharepoint excel services_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 のリストに「sharepoint excel services_hook」という新しい DAG が表示されるはずです。
この DAG をクリックし、次の画面で一時停止スイッチをクリックして青色にオンにします。次に、トリガー（再生）ボタンをクリックして DAG を実行します。これにより、sharepoint excel services_hook.py ファイル内の SQL クエリが実行され、コード内で指定したファイルパスに CSV として結果がエクスポートされます。
新しい DAG をトリガーした後、Downloads フォルダ（または Python スクリプト内で指定した場所）を確認すると、CSV ファイルが作成されていることがわかります。この例では account.csv です。
CSV ファイルを開くと、Apache Airflow によって SharePoint Excel Services のデータが CSV 形式で利用可能になっていることを確認できます。