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

OSS のETL ツールEmbulk のJDBC Plugin を使って、CouchDB のデータを簡単にDB に同期する方法をご紹介します。

杉本和也
リードエンジニア

最終更新日:2023-10-13

この記事で実現できるCouchDB 連携のシナリオ

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

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

Embulk でCouchDB のデータをロード

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

    Apache CouchDB 接続プロパティの取得・設定方法

    Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例:http://localhost:5984

    ユーザー(またはJWT)が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

    Apache CouchDB への認証

    3種類の認証をサポートします。
    • Basic:基本的なユーザー名 / パスワード認証。
    • JWT:JWT 認証。
    • None:パブリックなデータベースへの匿名アクセス。

    Basic 認証

    データに接続するには以下を設定します。

    • AuthSchemeBasic
    • User:認証に使用されるApache CouchDB ユーザーアカウント。
    • Password:認証するユーザーに関連付けられたApache CouchDB パスワード。

    その他の認証方法は、ヘルプドキュメント の「接続の確立」セクションを参照してください。

  • テーブル名は取得したいテーブル名を入れます。
  • これで準備完了です。あとは「embulk run」で実行するだけです。
  • embulk run apachecouchdb-mysql.yml
  • 実行後MySQL Workbenchからテーブルを確認してみると、データが取得できているはずです。

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

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

in: type: jdbc driver_path: C:\Program Files\CData\CData JDBC Driver for ApacheCouchDB 2019J\lib\cdata.jdbc.apachecouchdb.jar driver_class: cdata.jdbc.apachecouchdb.ApacheCouchDBDriver url: jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef; query: "SELECT MovieRuntime, MovieRating FROM Movies WHERE [RecordId] = 1" out: type: mysql host: localhost database: DatabaseName user: UserId password: UserPassword table: "Movies" mode: insert

おわりに

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。