各製品の資料を入手。
詳細はこちら →ETL ツールのEmbulk を使ってGraphQL のデータをDB にロードする方法
OSS のETL ツールEmbulk のJDBC Plugin を使って、GraphQL のデータを簡単にDB に同期する方法をご紹介します。
最終更新日:2023-10-13
この記事で実現できるGraphQL 連携のシナリオ
こんにちは!リードエンジニアの杉本です。
Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for GraphQL を使って、GraphQL のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。
Embulk でGraphQL のデータをロード
- CData JDBC Driver for GraphQL をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
-
以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
C:\Program Files\CData\CData JDBC Driver for GraphQL 2019J\lib\cdata.jdbc.graphql.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 ファイルを作成し、GraphQL -> MySQL のジョブを作成します。graphql-mysql.yml というファイル名で、以下の内容で作成しました。
- JDBC URL の内容は、ご利用の環境や資格情報を入力してください。
GraphQL サービスのURL を指定する必要があります。 ドライバーは2種類の認証をサポートします。
- Basic: AuthScheme をBasic に設定。GraphQL サービスのUser とPassword を指定する必要があります。
- OAuth 1.0 & 2.0: 詳しい説明は、ヘルプドキュメントのOAuth セクションを参照してください。
- テーブル名は取得したいテーブル名を入れます。
- これで準備完了です。あとは「embulk run」で実行するだけです。
- 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for GraphQL 2025J\lib\cdata.jdbc.graphql.jar
driver_class: cdata.jdbc.graphql.GraphQLDriver
url: jdbc:graphql:AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=REFRESH
table: "Users"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Users"
mode: insert
embulk run graphql-mysql.yml
クエリ条件でフィルタリングしたデータのロード
ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。
in:
type: jdbc
driver_path: C:\Program Files\CData\CData JDBC Driver for GraphQL 2019J\lib\cdata.jdbc.graphql.jar
driver_class: cdata.jdbc.graphql.GraphQLDriver
url: jdbc:graphql:AuthScheme=Basic;User=username;Password=password;URL=https://mysite.com;InitiateOAuth=REFRESH
query: "SELECT Name, Email FROM Users WHERE [RecordId] = 1"
out:
type: mysql
host: localhost
database: DatabaseName
user: UserId
password: UserPassword
table: "Users"
mode: insert
おわりに
CData JDBC Driver for GraphQL をEmbulk で使うことで、GraphQL と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。