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

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

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

はじめに

---

NetSuite への JDBC 接続を設定

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

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

NetSuiteへの接続

NetSuite では、2種類のAPI でデータにアクセスできます。どちらのAPI を使用するかは、Schema 接続プロパティで以下のいずれかを選択して指定してください。

• SuiteTalk は、NetSuite との通信に使用されるSOAP ベースの従来から提供されているサービスです。幅広いエンティティをサポートし、INSERT / UPDATE / DELETE の操作も対応しています。ただし、SuiteQL API と比べるとデータの取得速度が劣ります。また、サーバーサイドでのJOIN に対応していないため、これらの処理はCData 製品がクライアントサイドで実行します。
• SuiteQL は、より新しいAPI です。JOIN、GROUP BY、集計、カラムフィルタリングをサーバーサイドで処理できるため、SuiteTalk よりもはるかに高速にデータを取得できます。ただし、NetSuite データへのアクセスは読み取り専用となります。

データの取得のみが目的でしたらSuiteQL をお勧めします。データの取得と変更の両方が必要な場合は、SuiteTalk をお選びください。

NetSuite への認証

CData 製品では、以下の認証方式がご利用いただけます。

• トークンベース認証（TBA）はOAuth1.0に似た仕組みです。2020.2以降のSuiteTalk とSuiteQL の両方で利用できます。
• OAuth 2.0 認証（OAuth 2.0 認可コードグラントフロー）は、SuiteQL でのみご利用いただけます。
• OAuth JWT 認証は、OAuth2.0 クライアント認証フローの一つで、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。

トークンベース認証（OAuth1.0）

トークンベース認証（TBA）は、基本的にOAuth 1.0 の仕組みです。この認証方式はSuiteTalk とSuiteQL の両方でサポートされています。管理者権限をお持ちの方がNetSuite UI 内でOAuthClientId、OAuthClientSecret、OAuthAccessToken、OAuthAccessTokenSecret を直接作成することで設定できます。 NetSuite UI でのトークン作成手順については、ヘルプドキュメントの「はじめに」セクションをご参照ください。

アクセストークンを作成したら、以下の接続プロパティを設定して接続してみましょう。

• AuthScheme = Token
• AccountId = 接続先のアカウント
• OAuthClientId = アプリケーション作成時に表示されるコンシューマーキー
• OAuthClientSecret = アプリケーション作成時に表示されるコンシューマーシークレット
• OAuthAccessToken = アクセストークン作成時のトークンID
• OAuthAccessTokenSecret = アクセストークン作成時のトークンシークレット

その他の認証方法については、ヘルプドキュメントの「はじめに」をご確認ください。

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

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

java -jar cdata.jdbc.netsuite.jar

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

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

jdbc:netsuite:AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;

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

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

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

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.netsuite.jar
	driver_class: cdata.jdbc.netsuite.NetSuiteDriver
	url: jdbc:netsuite:AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
	table: "SalesOrder"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SalesOrder"
	mode: insert

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

embulk run netsuite-mysql.yml

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

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

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

in:
	type: jdbc
	driver_path: C:\Program Files\CData[product_name] 20xx\lib\cdata.jdbc.netsuite.jar
	driver_class: cdata.jdbc.netsuite.NetSuiteDriver
	url: jdbc:netsuite:AccountId=XABC123456;Schema=SuiteTalk;AuthScheme=Token;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;OAuthAccessToken=MyOAuthAccessToken;OAuthAccessTokenSecret=MyOAuthAccessTokenSecret;
	query: "SELECT CustomerName, SalesOrderTotal FROM SalesOrder WHERE [RecordId] = 1"
out:
	type: mysql
	host: localhost
	database: DatabaseName
	user: UserId
	password: UserPassword
	table: "SalesOrder"
	mode: insert

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

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