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

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

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

Sage X3 Cloud への JDBC 接続を設定

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

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

Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

• URL：Sage X3 Cloud インスタンスのベース URL。
• OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
• OAuthClientId：OAuth アプリケーションのクライアント ID。
• OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
• Audience：トークンリクエストで使用する API の Audience 値。
• XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
• Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
• Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

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

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

java -jar cdata.jdbc.sagex3cloud.jar

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

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

jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;

Embulk で Sage X3 Cloud ののデータをロード

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

Sage X3 Cloud ののデータをロードするジョブを作成

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud 20xx\lib\cdata.jdbc.sagex3cloud.jar
	driver_class: cdata.jdbc.sagex3cloud.SageX3CloudDriver
	url: jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;
	table: "BPCUSTOMER"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "BPCUSTOMER"
	mode: insert

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

embulk run sagex3cloud-mysql.yml

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

フィルタリングした Sage X3 Cloud ののデータをロード

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData\CData JDBC Driver for Sage X3 Cloud 20xx\lib\cdata.jdbc.sagex3cloud.jar
	driver_class: cdata.jdbc.sagex3cloud.SageX3CloudDriver
	url: jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;
	query: "SELECT BPCNUM, BPCNAM FROM BPCUSTOMER WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "BPCUSTOMER"
	mode: insert

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

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