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

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

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

Square への JDBC 接続を設定

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

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

Square OAuth 認証標準を使用します。OAuth を使用して認証するには、Square にアプリを登録してOAuthClientId、OAuthClientSecret、CallbackURL を入手します。OAuth の使用方法については、ヘルプドキュメントの「はじめに」セクションをご覧ください。

追加でLocationId を指定する必要がある場合があります。Locations テーブルをクエリすることでLocations のId を取得できます。または、クエリの検索項目にLocationId を設定することもできます。

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

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

java -jar cdata.jdbc.square.jar

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

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

jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;

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

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 を使用してSquare のデータをMySQL にロードする準備が整いました。

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.square.jar
	driver_class: cdata.jdbc.square.SquareDriver
	url: jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;
	table: "Refunds"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Refunds"
	mode: insert

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

embulk run square-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.square.jar
	driver_class: cdata.jdbc.square.SquareDriver
	url: jdbc:square:OAuthClientId=MyAppId;OAuthClientSecret=MyAppSecret;CallbackURL=http://localhost:33333;LocationId=MyDefaultLocation;
	query: "SELECT Reason, RefundedMoneyAmount FROM Refunds WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Refunds"
	mode: insert

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

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