Apache Airflow で Harvest データを連携

Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
CData JDBC Driver を使用して、Apache Airflow で Harvest のデータ にアクセスして処理。

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

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

Harvest への接続を設定

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

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

java -jar cdata.jdbc.api.jar

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

まず、Profile 接続プロパティをディスク上のHarvest プロファイルの場所に設定します（例：C:\profiles\Harvest.apip）。次に、ProfileSettings 接続プロパティをHarvest の接続文字列に設定します（以下を参照）。

Harvest API プロファイル設定

Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

トークン認証の使用

トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

OAuth 認証の使用

まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • ProfileSettings：ProfileSettings でAccountId を設定します。
  • AuthScheme：OAuth に設定します。
  • OAuthClientId：アプリ設定で指定したclient ID に設定します。
  • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
  • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。

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

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

プロパティ値
データベース接続 URLjdbc:api:RTK=5246...;Profile=C:\profiles\Harvest.apip;ProfileSettings='APIKey=my_personal_key;AccountId=_your_account_id';
データベースドライバークラス名cdata.jdbc.api.APIDriver

Airflow で JDBC 接続を設定

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

DAG の作成

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

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

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

CData API Driver for JDBC の30日間無料トライアルをダウンロードして、Apache Airflow でリアルタイムの Harvest のデータ を活用してみてください。ご質問があれば、サポートチームまでお気軽にお問い合わせください。

はじめる準備はできましたか？

API Driver で Harvest のライブデータに接続

Harvest に接続 お問い合わせ

この記事の内容

関連記事