データ統合ツールQlik Replicate を使ってREST のデータをMySQL にレプリケートする方法

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

Qlik Replicate はBI ツールのQlik Sense で有名な、Qlik 社が提供するデータ分析基盤のためのデータパイプライン・データ統合ツールです。主要なプラットフォームに多く対応しているのが特徴で、AWS・GCP・Azure・Oracle・Snowflake などのDWH に各種データを取り込むことが可能です。

Qlik Replicate ではODBC インターフェースが用意されているので、CData ODBC Driver for REST と組み合わせることで、各種クラウドサービスのAPI にアクセスすることができるようになります。本記事では、CData ODBC ドライバを使ってQlik Replicate からREST のデータをMySQL にレプリケートする方法をご紹介します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. REST をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにREST のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてREST の接続を設定、2.Qlik Replicate 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとREST への接続設定

まずは、本記事右側のサイドバーからREST ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

インストール後、ODBC DSN（データソース名）で接続プロパティを設定します。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および設定できます。

データソースへの認証については、データプロバイダーのヘルプドキュメントの「はじめに」を参照してください: データプロバイダーはREST API を双方向データベーステーブルとして、XML/JSON ファイル（ローカルファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）を読み取り専用のビューとしてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。認証についての詳細は、ヘルプドキュメントの「はじめに」を参照してください。

URI を設定し、認証値を指定したら、Format を"XML" または"JSON" に設定して、データ表現をデータ構造により厳密に一致させるようにDataModel を設定します。

DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、以下の基本的な設定を切り替えます。

• Document （デフォルト）：REST データのトップレベルのドキュメントビューをモデル化します。データプロバイダーはネストされたエレメントをデータの集計として返します。
• FlattenedDocuments：ネストされたドキュメントとその親を単一テーブルとして暗黙的に結合します。
• Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれます。

リレーショナル表現の構成について詳しくは、「REST データのモデル化」を参照してください。次の例で使用されているサンプルデータもあります。データには、人、所有している車、およびそれらの車で行われたさまざまなメンテナンスサービスのエントリが含まれています。The data includes entries for people, the cars they own, and various maintenance services performed on those cars.

Qlik Replicate にODBC データソースを追加

CData ODBC ドライバの設定が完了したら、Qlik Replicate を立ち上げてレプリケーション構成を進めていきましょう。Qlik Replicate ではタスクという単位でレプリケーション処理を構成していきますが、まずタスクで利用するデータソースとレプリケーション先のコネクション情報を登録する必要があるので、この設定を行います。

1. Qlik Replicate の管理画面に移動したら、 「Manage Endpoint Connections…」をクリックします。
2. その後表示される画面で、「＋New Endpoint Connection」をクリック。この画面からデータソースとレプリケーション先（ターゲット）のコネクションを構成していきます。
3. まずはデータソースとなるREST へのコネクションを構成します。前述の通り、REST への連携はCData ODBC ドライバを経由して行うため、「Role：Source」「Type：ODBC」でコネクションを構成します。
4. そして、事前に構成しておいたREST のDSN を指定します。任意のName を指定したあと、Test Connection がパスできれば設定完了です。

MySQL Target 接続を追加

続いて、レプリケーション先となるMySQL へのコネクションも追加します。

1. 先程と同じように「＋New Endpoint Connection」をクリックします。
2. 「Role: Target」「Type: MySQL」を指定して、Server アドレスやUserName、Password などMySQL 接続に必要な接続情報をそれぞれ指定し、保存します。

Task の構成

コネクションの作成が完了したら、実際のレプリケーション処理であるTask の作成を進めていきましょう。

1. 「＋New Task」をクリックし、任意の名称でTask を作成します。Replication Profileは「Unidirectional：単方向」でTask Optionsは「Full Load」を指定します。
2. タスク作成後の画面で、データソースには先程作成したREST のコネクションを、ターゲットにはMySQL のコネクションを、ドラッグドロップでそれぞれ指定します。

レプリケーション対象のテーブルを選択

データソースとターゲットを決めたら、レプリケーション対象のテーブルを指定しましょう。

1. 「Table Selection」をクリックします。
2. 「Search」をクリックして、対象となるテーブルを検索します。以下のようにREST のテーブル一覧が表示されるので、任意のテーブルを選択していきます。
3. これで以下のように選択されればOK です。ちなみにデフォルトではテーブルの全レコード・全カラムをレプリケーションしますが、Global Rules から細かな条件や項目の設定がチューニング可能です。

作成したTask を実行

それでは作成したTask を実際に実行してみましょう。

1. 「Run」をクリックすることで、レプリケーションを開始できます。
2. レプリケーションが進むとMonitor 画面に遷移し、レプリケーション結果を確認できます。Completed が表示されればOKです。
3. 実際にMySQL のテーブルを確認してみると、以下のようにテーブルが自動生成され、データが正常に複製されていました。

おわりに

このようにCData ODBC ドライバを利用することで、各種クラウドサービスをQlik Replicate の接続先として利用できるようになります。 CData ではREST 以外にも270種類以上のデータソース向けにODBC Driver を提供しています。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Sync は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。