Apache Airflow で HubSpot データを連携

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

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

はじめに

---

HubSpot への接続を設定

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

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

java -jar cdata.jdbc.hubspot.jar

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

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

HubSpot はOAuth 認証 およびPrivateAppToken ベース認証をサポートします。

OAuth

HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションまたはヘッドレスマシンから簡単に接続できます。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションを作成する必要があります。 OAuth 経由で接続するには、すべての認証フローでAuthScheme をOAuth に設定します。 ヘルプドキュメントでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、「カスタムOAuth アプリケーションの作成」セクション を参照してください。

また、PrivateAppToken ベース認証についてはヘルプドキュメントの「接続の確立」セクションを参照してください。

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

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

Airflow で JDBC 接続を設定

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

DAG の作成

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

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

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