各製品の資料を入手。
詳細はこちら →ETL ツールのEmbulk を使ってIBM Cloud Object Storage のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、IBM Cloud Object Storage のデータを簡単にDB に同期する方法をご紹介します。
最終更新日:2023-10-13
この記事で実現できるIBM Cloud Object Storage 連携のシナリオ
こんにちは!リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for IBMCloudObjectStorage を使って、IBM Cloud Object Storage のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でIBM Cloud Object Storage のデータをロード
- CData JDBC Driver for IBMCloudObjectStorage をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for IBMCloudObjectStorage 2019J\lib\cdata.jdbc.ibmcloudobjectstorage.jar 次に、EmbulkとCData JDBC Driverをつなぎこむための、JDBC Input Plugin をインストールします。以下のリンクからダウンロードできます。
https://github.com/embulk/embulk-input-jdbc/tree/master/embulk-input-jdbcインストール用のコマンドはこちら:
embulk gem install embulk-input-jdbc
今回はロード先DB としてMySQL を使います。ほかにもSQL Server、PostgreSQL、Google BigQuery などを使うことも可能です。ロードに必要な以下のプラグインをインストールしましょう。
https://github.com/embulk/embulk-output-jdbc/tree/master/embulk-output-mysqlコマンドはこちら。
embulk gem install embulk-output-mysql
- config ファイルを作成し、IBM Cloud Object Storage -> MySQL のジョブを作成します。ibmcloudobjectstorage-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
Cloud Object Storage 接続プロパティの取得・設定方法
Cloud Object Storage に接続する前に、Cloud Object Storage インスタンスを登録してCloud Object Storage API キーとCRN を取得していきます。
Cloud Object Storage の新規インスタンスの登録
IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。
- IBM Cloud アカウントにログインします。
- Cloud Object Storage ページに移動して、インスタンス名を指定して「作成」をクリックします。Cloud Object Storage の新規インスタンスにリダイレクトされます。
API キー
API キーは以下の手順で取得できます。
- まずは、IBM Cloud アカウントにログインします。
- API キーページに移動します。
- 中央右隅のIBM Cloud APIキーの作成 をクリックして、新しいAPI キーを作成します。
- ポップアップウィンドウが表示されたら、API キーの名前を指定して作成をクリックします。ダッシュボードからはアクセスできなくなるため、API Key を控えておきましょう。
Cloud Object Storage CRN
デフォルトでは、CData 製品はCloud Object Storage CRN を自動で取得します。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。
- Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
- IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud のダッシュボードに移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。
IBM Cloud Object Storage への接続
これで準備は完了です。以下の接続プロパティを設定してください。
- InitiateOAuth:GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 認証を繰り返す必要がなく、さらに自動でアクセストークンを設定できます。
- ApiKey:セットアップ中に控えたAPI キーを指定。
- CloudObjectStorageCRN(オプション):控えておいたCloud Object Storage のCRN に設定。Cloud Object Storage アカウントが複数ある場合のみ設定する必要があります。
プロパティを設定したら、これで接続設定は完了です。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for IBMCloudObjectStorage 2025J\lib\cdata.jdbc.ibmcloudobjectstorage.jar
driver_class: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
url: jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
table: "Objects"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Objects"
mode: insert
embulk run ibmcloudobjectstorage-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for IBMCloudObjectStorage 2019J\lib\cdata.jdbc.ibmcloudobjectstorage.jar
driver_class: cdata.jdbc.ibmcloudobjectstorage.IBMCloudObjectStorageDriver
url: jdbc:ibmcloudobjectstorage:ApiKey=myApiKey;CloudObjectStorageCRN=MyInstanceCRN;Region=myRegion;OAuthClientId=MyOAuthClientId;OAuthClientSecret=myOAuthClientSecret;
query: "SELECT Key, Etag FROM Objects WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Objects"
mode: insert
おわりに
CData JDBC Driver for IBMCloudObjectStorage をEmbulk で使うことで、IBM Cloud Object Storage と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。