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

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

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

Stripe への JDBC 接続を設定

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

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

Stripeへの接続

それでは、Stripe への接続について説明していきましょう。Stripe では、本番API キーまたはOAuth のいずれかによる認証をサポートしています。

本番API キー

本番API キーで接続するには、以下の2つの設定パラメータを設定する必要があります。

• AuthScheme = APIKey
• LiveAPIKey = 本番API キーの値

本番API キーの値を取得するには、以下の手順で確認できます：

1. Stripe ダッシュボードにログインします
2. 開発者 → API キー → シークレットキー → 本番環境のキーを表示 に移動します

Stripe では、テストモードで作成されたシークレットキーを使用して、'StripeV2' データモデルのエンティティにはアクセスできませんのでご注意ください。ライブモードまたはサンドボックスモードで作成されたシークレットキーをご利用ください。 さらに、制限付きキーを使用して'StripeV2' データモデルのエンティティにアクセスすることも許可されていません。

OAuth については、ヘルプドキュメントの「接続の確立」をご確認ください。

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

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

java -jar cdata.jdbc.stripe.jar

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

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

jdbc:stripe:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.stripe.jar
	driver_class: cdata.jdbc.stripe.StripeDriver
	url: jdbc:stripe:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;
	table: "Customers"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

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

embulk run stripe-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.stripe.jar
	driver_class: cdata.jdbc.stripe.StripeDriver
	url: jdbc:stripe:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;
	query: "SELECT Email, Discount FROM Customers WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "Customers"
	mode: insert

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

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