Embulk を使用して HubSpot ののデータをデータベースにロードする方法

Embulk はオープンソースのバルクデータローダーです。CData JDBC Driver for HubSpot と組み合わせることで、HubSpot から任意の同期先にデータを簡単にロードできます。この記事では、CData JDBC Driver for HubSpot をEmbulk で使用してHubSpot のデータをMySQL データベースにロードする方法を解説します。

CData JDBC Driver は、最適化されたデータ処理機能を内蔵しており、リアルタイムのHubSpot のデータに対して比類のないパフォーマンスを発揮します。HubSpot に対して複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作を直接HubSpot にプッシュし、サポートされていない操作（SQL 関数やJOIN 操作など）は組み込みのSQL エンジンを使用してクライアント側で処理します。

はじめに

---

HubSpot への JDBC 接続を設定

Embulk でバルクロードジョブを作成する前に、JDBC Driver のJAR ファイルのインストール場所（通常はC:\Program Files\CData\CData JDBC Driver for HubSpot\lib）を確認しておきます。

Embulk はJDBC 接続をサポートしているため、HubSpot に簡単に接続してSQL クエリを実行できます。バルクロードジョブを作成する前に、HubSpot への認証用のJDBC URL を作成します。

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

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

OAuth

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

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

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

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

java -jar cdata.jdbc.hubspot.jar

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

以下は、HubSpot への一般的なJDBC 接続文字列です。

jdbc:hubspot:

Embulk で HubSpot ののデータをロード

CData JDBC Driver をインストールしてJDBC 接続文字列を作成したら、必要なEmbulk プラグインをインストールします。

Embulk の入力・出力プラグインをインストール

1. Embulk にJDBC 入力プラグインをインストールします。
   https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbc

embulk gem install embulk-input-jdbc

2. この記事では、同期先データベースとしてMySQL を使用します。出力プラグインを使用して、SQL Server、PostgreSQL、またはGoogle BigQuery を同期先として選択することもできます。
   https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysql

   embulk gem install embulk-output-mysql
   

入力プラグインと出力プラグインをインストールしたら、Embulk を使用してHubSpot のデータをMySQL にロードする準備が整いました。

HubSpot ののデータをロードするジョブを作成

まず、Embulk で設定ファイルを作成します。ファイル名はhubspot-mysql.yml のようにします。

1. 入力プラグインのオプションには、CData JDBC Driver for HubSpot、ドライバーJAR ファイルへのパス、ドライバークラス（例：cdata.jdbc.hubspot.HubSpotDriver）、および上記のJDBC URL を指定します。
2. 出力プラグインのオプションには、MySQL データベースの値と認証情報を指定します。

設定ファイルのサンプル（hubspot-mysql.yml）

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.hubspot.jar
	driver_class: cdata.jdbc.hubspot.HubSpotDriver
	url: jdbc:hubspot:
	table: "Prospects"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Prospects"
	mode: insert

ファイルを作成したら、Embulk ジョブを実行します。

embulk run hubspot-mysql.yml

Embulk ジョブを実行すると、MySQL テーブルにHubSpot のデータが格納されます。

フィルタリングした HubSpot ののデータをロード

テーブルから直接データをロードするだけでなく、カスタムSQL クエリを使用してロードするデータをより詳細に制御できます。また、クエリフィールドのSQL WHERE 句で最終更新カラムを設定することで、増分ロードを実行することもできます。

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.hubspot.jar
	driver_class: cdata.jdbc.hubspot.HubSpotDriver
	url: jdbc:hubspot:
	query: "SELECT Slug, PageViews FROM Prospects WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Prospects"
	mode: insert

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

CData JDBC Driver for HubSpot をコネクタとして使用することで、Embulk のデータロードジョブにHubSpot のデータを統合できます。また、200 を超えるエンタープライズデータソース向けドライバーにより、あらゆるエンタープライズSaaS、ビッグデータ、NoSQL ソースも統合できます。30日間の無料トライアルをダウンロードして、今すぐお試しください。