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

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

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

PayPal への JDBC 接続を設定

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

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

それでは、PayPal への接続について説明していきましょう。CData製品では、2つのPayPal API のテーブルに対応しています。これらのAPI は、それぞれ異なる認証方法を使用します。

• REST API はOAuth 標準を使用します。REST API で認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定してください
• 非推奨：SOAP API は廃止予定です。より優れたリソースアクセスのため、REST API のご利用をお勧めします

必要なAPI 資格情報の取得方法については、ヘルプドキュメントの「はじめに」をご確認ください。

使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。

テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報をご利用いただけます。

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

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

java -jar cdata.jdbc.paypal.jar

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

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

jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.paypal.jar
	driver_class: cdata.jdbc.paypal.PayPalDriver
	url: jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;
	table: "Transactions"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Transactions"
	mode: insert

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

embulk run paypal-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.paypal.jar
	driver_class: cdata.jdbc.paypal.PayPalDriver
	url: jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;
	query: "SELECT Date, GrossAmount FROM Transactions WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Transactions"
	mode: insert

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

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