ETL ツールのEmbulk を使ってPostgreSQL データをDB にロードする方法

こんにちは！リードエンジニアの杉本です。

Embulk は、大量のデータをDB、クラウドデータストア、DWH にロードできるオープンソースETL ツールです。近頃のトレンドでは1社で複数のオンプレアプリやSaaS を使っており、データ分析にはETL ツールを使ってデータを丸ごとDB/DWH にロードしてから、分析や可視化をすることが主流になっています。Embulk にはいろいろなプラグインがあり、多様なInput とOutput 処理をサポートしています。この記事では、Embulk のJDBC Input Plugin と CData Driver for PostgreSQL を使って、PostgreSQL のデータを簡単にDB にロードする方法をご紹介します。この例ではロード先のDB にはMySQL を使います。

Embulk でPostgreSQL のデータをロード

• CData JDBC Driver for PostgreSQL をEmbulk と同じマシンにインストールします。CData JDBC ドライバは30日間の無償トライアルが利用できるので、サイドバーからお気軽にダウンロードしてご利用ください。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。
  C:\Program Files\CData\CData JDBC Driver for PostgreSQL 2019J\lib\cdata.jdbc.postgresql.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 ファイルを作成し、PostgreSQL -> MySQL のジョブを作成します。postgresql-mysql.yml というファイル名で、以下の内容で作成しました。
in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for PostgreSQL 2024J\lib\cdata.jdbc.postgresql.jar driver_class: cdata.jdbc.postgresql.PostgreSQLDriver url: jdbc:postgresql:User=postgres;Password=admin;Database=postgres;Server=127.0.0.1;Port=5432; table: "Orders" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Orders" mode: insert
• JDBC URL の内容は、ご利用の環境や資格情報を入力してください。

  PostgreSQL への接続には、Server、Port（デフォルトは5432）、Database、およびUser、Password のプロパティを設定します。Database プロパティが設定されない場合には、User のデフォルトデータベースに接続します。

  パスワード方式によるSSH 接続

  パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

  • User: PostgreSQL のユーザ
  • Password: PostgreSQL のパスワード
  • Database: PostgreSQL の接続先データベース
  • Server: PostgreSQL のサーバー
  • Port: PostgreSQL のポート
  • UserSSH: "true"
  • SSHAuthMode: "Password"
  • SSHPort: SSH のポート
  • SSHServer: SSH サーバー
  • SSHUser: SSH ユーザー
  • SSHPassword: SSH パスワード

  接続文字列形式では以下のようになります。

  User=admin;Password=adminpassword;Database=test;Server=postgresql-server;Port=5432;UseSSH=true;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

  公開鍵認証方式方式によるSSH 接続

  公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

  • User: PostgreSQL のユーザ
  • Password: PostgreSQL のパスワード
  • Database: PostgreSQL の接続先データベース
  • Server: PostgreSQL のサーバー
  • Port: PostgreSQL のポート
  • UserSSH: "true"
  • SSHAuthMode: "Public_Key"
  • SSHClientCertType: キーストアの種類
  • SSHPort: SSH のポート
  • SSHServer: SSH サーバー
  • SSHUser: SSH ユーザー
  • SSHClientCert: 秘密鍵ファイルのパス

  接続文字列形式では以下のようになります。

  User=admin;Password=adminpassword;Database=test;Server=PostgreSQL-server;Port=5432;UseSSH=true;SSHClientCertType=PEMKEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;
• テーブル名は取得したいテーブル名を入れます。
• これで準備完了です。あとは「embulk run」で実行するだけです。
embulk run postgresql-mysql.yml
• 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

クエリ条件でフィルタリングしたデータのロード

ちなみに、上記の例ではテーブル名を直接指定しましたが、以下のようにSQL クエリを書いてもいいです。 WHERE 句で作成日や修正日を指定すれば、最新のデータだけを対象にすることも可能です。

おわりに

CData JDBC Driver for PostgreSQL をEmbulk で使うことで、PostgreSQL と連携して簡単にデータを取得できます。ぜひ、30日の無償評価版をお試しください。