【ノーコード】複数のAPI アカウントのデータを簡単レプリケーション

宮本航太
宮本航太
プロダクトスペシャリスト
複数API アカウント(sandbox/本番など)連携の複雑さをCData Sync でノーコード解決。テーブルprefix・スキーマ分離で環境別の管理も簡単、自動同期を実現する手順を詳解。



CData Sync は、いろいろなシナリオのデータレプリケーション(同期)を行うことができるスタンドアロンのアプリケーションです。例えば、sandbox および本番インスタンスのデータをデータベースに同期することができます。CData Sync のウェブインターフェースは複数のAPI コネクションを簡単に管理できます。本記事では、複数のAPI アカウントを一つのデータベースに同期する方法を説明します。

レプリケーションの同期先を設定

CData Sync では、API のデータ を何台のデータベースにでも複製できます。データベースはクラウドおよびオンプレミスの双方に対応しています。レプリケーションの同期先の設定には、[接続]タブから行います。

  1. [同期先]タブを選択します。
  2. 同期先のアイコンをクリックします。本記事では、SQLite を使います。
  3. 必要な接続プロパティを入力します。API をSQLite に複製するには、データソースボックスにファイルパスを指定します。
  4. [接続のテスト]をクリックして、正しく接続できているかをテストします。 同期先接続の設定(SQLite の例)
  5. [変更を保存]をクリックします。

API 接続の設定

データソース側にAPI を設定します。[接続]タブをクリックします。

  1. [接続の追加]セクションで[データソース]タブを選択します。
  2. API アイコンをデータソースとして選択します。プリインストールされたソースにAPI がない場合には、追加データソースとしてダウンロードします。
  3. 接続プロパティに入力をします。

    お使いのAPIに接続するには、グローバル設定ページで以下のプロパティを設定してください。

    • AuthenticationTypeを選択し、必要なプロパティを入力します
    • Headersで、お使いのAPIに必要なHTTPヘッダーを追加します
    • PaginationTypeを選択し、必要なプロパティを入力します

    グローバル設定の完了後、Tablesに移動してテーブルを追加します。テーブルごとに以下の手順を実行してください。

    1. 「+ Add」をクリックします
    2. テーブルのNameを設定します
    3. 使用するAPIエンドポイントのRequest URLを設定します リクエストURLの設定(Harvestの例)
    4. (オプション)Parametersで、APIエンドポイントに必要なURLパラメーターを追加します
    5. (オプション)Headersで、APIエンドポイントに必要なHTTPヘッダーを追加します
    6. Table Dataの「 Configure」をクリックします
    7. APIからのレスポンスを確認し、「Next」をクリックします APIレスポンスの確認(Harvestの例)
    8. Repeated Elementsに使用する要素とColumnsに使用する要素を選択し、「Next」をクリックします APIレスポンスに基づくスキーマの設定(Harvestの例)
    9. APIレスポンスの表形式プレビューを確認し、「Confirm」をクリックします APIレスポンスの表形式プレビュー(Harvestの例)
    データソースセクションの設定(Salesforce 画面を例示)。
  4. [接続のテスト]をクリックして、正しく接続できているかをテストします。
  5. [変更を保存]をクリックします。

それぞれのAPI インスタンスのレプリケーションクエリの設定

Data Sync はレプリケーションをコントロールするSQL クエリを簡単なGUI 操作で設定できます。 レプリケーションジョブ設定には、[ジョブ]タブに進み、[ジョブを追加]ボタンをクリックします。 次にデータソースおよび同期先をそれぞれドロップダウンから選択します。 レプリケーションジョブのソースおよび同期先を選択。

テーブル全体をレプリケーションする

テーブル全体をレプリケーションするには、[テーブル]セクションで[テーブルを追加]をクリックします。表示されたテーブルリストからレプリケーションするテーブルをチェックします。.

レプリケーションするテーブルの選択(画像はSalesforce の例)。

テーブルをカスタマイズしてレプリケーションする

SQL クエリを使って、レプリケーションをカスタマイズできます。REPLICATE 構文はデータベースのテーブルにデータをキャッシュし、保存するハイレベルコマンドです。API API がサポートするSELECT クエリを定義することができます。レプリケーションのカスタマイズにはテーブルセクションで[カスタムクエリの追加]をクリックして、クエリステートメントを記述します。

レプリケーションのカスタマイズ設定。

API のデータ のテーブルを差分更新でキャッシュするステートメントは次のとおり:

REPLICATE posts;

使用するレプリケーションクエリを含むファイルを指定することで特定のデータベースを更新することが可能です。レプリケーションステートメントをセミコロンで区切ります。次のオプションは一つのデータベースに複数のAPI アカウントのデータを同期する例です:

  • REPLICATE SELECT ステートメントで異なるtable prefix を使用する:

    REPLICATE PROD_posts SELECT * FROM posts;
    
  • 別の方法として、異なるスキーマを使うことも可能です:

    REPLICATE PROD.posts SELECT * FROM posts;
    

レプリケーションのスケジュール起動

[スケジュール]セクションでは、レプリケーションジョブの自動起動スケジュール設定が可能です。反復同期間隔は、15分おきから毎月1回までの間で設定が可能です。

レプリケーションの自動起動スケジューリング。

レプリケーションジョブを設定したら、[変更を保存]します。このように複数のAPI アカウントのデータを複製するジョブを作成することができました。

はじめる準備はできましたか?

詳細はこちら、または無料トライアルにお申し込みください:

CData Sync