SQLite にShipStation のデータを連携・統合する方法

こんにちは！プロダクトスペシャリストの宮本です。

CData Sync は、数百のSaaS / DB のデータをSqlite をはじめとする各種DB / データウェアハウスにノーコードで統合・レプリケーション（複製）が可能なETL / ELT ツールです。本記事では、ShipStation のデータをCData Sync を使ってSqlite に統合するデータパイプラインを作っていきます。

CData Sync とは？

CData Sync は、レポーティング、アナリティクス、機械学習、AI などで使えるよう、社内のデータを一か所に統合して管理できるデータ基盤をノーコードで構築できるETL ツールで、以下の特徴を持っています。

1. ShipStation をはじめとする数百種類のSaaS / DB データに対応
2. Sqlite など多くのRDB、データレイク、データストア、データウェアハウスに同期可能
3. 業務データのデータ分析基盤へのETL / ELT 機能に特化し、極限まで設定操作をシンプルに
4. 主要なSaaS データの差分更新やCDC（Change Data Capture、変更データキャプチャ）のサポート
5. フレキシブルなSQL / dbt 連携での取得データの変換

CData Sync では、1.データソースとしてShipStation の接続を設定、2.同期先としてSqlite の接続を設定、3.ShipStation からSqlite へのレプリケーションジョブの作成、という3つのステップだけでレプリケーション処理を作成可能です。以下に具体的な設定手順を説明します。

1.データソースとしてShipStation の接続を設定

まずはじめに、CData Sync のブラウザ管理コンソールにログインします。CData Sync のインストールをまだ行っていない方は本記事の製品リンクからCData Sync をクリックして、30日の無償トライアルとしてCData Sync をインストールしてください。インストール後にCData Sync が起動して、ブラウザ設定画面が開きます。

それでは、データソース側にShipStation を設定していきましょう。左の［接続］タブをクリックします。

1. ［＋接続の追加］ボタンをクリックします。
2. ［データソース］タブを選択して、リスト表示されるデータソースを選ぶか、検索バーにデータソース名を入力して、ShipStation を見つけます。
3. ShipStation の右側の［→］をクリックして、ShipStation アカウントへの接続画面を開きます。もし、ShipStation のコネクタがデフォルトでCData Sync にインストールされていない場合には、ダウンロードアイコン（コネクタのアップロードアイコン）をクリックし、［ダウンロード］をクリックすると、CData Sync にコネクタがインストールされます。
4. 接続プロパティにShipStation に接続するアカウント情報を入力をします。
   

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

   ShipStation への接続には、BASIC 認証標準を使います。

   1. ShipStation アカウントにログインします。
   2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
   3. ［アカウント］->［API 設定］をクリックします。
   4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

   ShipStation への認証

   • APIKey：［API 設定］ページのAPI Key に設定します。
   • APISecret：［API 設定］ページのSecret key に設定します。
   
5. ［作成およびテスト］をクリックして、正しくShipStation に接続できているかをテストして保存します。これでレプリケーションのデータソースとしてShipStation への接続が設定されました。

2.同期先としてSqlite の接続を設定

次に、ShipStation のデータを書き込む先（＝同期先）として、Sqlite を設定します。同じく［接続］タブを開きます。

1. ［＋接続の追加］ボタンをクリックします。
2. ［同期先］タブを選択して、リスト表示されるデータソースを選ぶか、検索バーにデータソース名を入力して、Sqlite を見つけます。
3. Sqlite の右側の［→］をクリックして、Sqlite データベースへの接続画面を開きます。もし、Sqlite のコネクタがデフォルトでCData Sync にインストールされていない場合には、ダウンロードアイコン（コネクタのアップロードアイコン）をクリックし、［ダウンロード］をクリックすると、CData Sync にコネクタがインストールされます。
4. 必要な接続プロパティを入力します。SQLite との接続には、以下のプロパティが必要です:
   • Data Source: データベースのパス。既存のデータベース、もしくは新しいデータベースにレプリケーションが可能です。Data Sync アプリケーションはデータベースへのアクセスが必要です。
5. ［［作成およびテスト］をクリックして、正しく接続できているかをテストします。
6. これで同期先としてSqlite を設定できました。CData Sync では、Sqlite のデータベース名を指定するだけで、同期するShipStation に併せたテーブルスキーマを自動的にCREATE TABLE してくれます。同期データに合わせたテーブルを事前に作成するなどの面倒な手順は必要ありません。もちろん、既存テーブルにマッピングを行いデータ同期を行うことも可能です。

3.ShipStation からSqlite へのレプリケーションジョブの作成

CData Sync では、レプリケーションをジョブ単位で設定します。ジョブは、ShipStation からSqlite という単位で設定し、複数のテーブルを含むことができます。レプリケーションジョブ設定には、［ジョブ］タブに進み、［＋ジョブを追加］ボタンをクリックします。

［ジョブを追加］画面が開き、以下を入力します：

1. 名前：ジョブの名前
2. データソース：ドロップダウンリストから先に設定したShipStation を選択
3. 同期先：先に設定したSqlite を選択

すべてのオブジェクトをレプリケーションする場合

ShipStation のすべてのオブジェクト / テーブルをレプリケーションするには、［種類］セクションで［すべて同期］を選択して、［タスクを追加］ボタンで確定します。

作成したジョブ画面で、右上の［▷実行］ボタンをクリックするだけで、全ShipStation テーブルのSqlite への同期を行うことができます。

オブジェクトを選択してレプリケーションする場合

ShipStation から特定のオブジェクト / テーブルを選択してレプリケーションを行うことが可能です。［種類］セクションでは、［標準（個別設定）］を選んでください。

次に［ジョブ］画面で、［タスク］タブをクリックし、［タスクを追加］ボタンをクリックします。

するとCData Sync で利用可能なオブジェクト / テーブルのリストが表示されるので、レプリケーションを行うオブジェクトにチェックを付けます（複数選択可）。［タスクを追加］ボタンで確定します。

作成したジョブ画面で、［▷実行］ボタンをクリックして（もしくは各タスク毎の実行ボタンを押して）、レプリケーションジョブを実行します。

このようにとても簡単にShipStation からSqlite への同期を行うことができました。

CData Sync の主要な機能を試してみる：スケジューリング・差分更新・ETL

ジョブのスケジュール起動設定

CData Sync では、同期ジョブを1日に1回や15分に1回などのスケジュール起動をすることができます。ジョブ画面の［概要］タブから［スケジュール］パネルを選び、［⚙設定］ボタンをクリックします。［間隔］と同期時間の［毎時何分］を設定し、［保存］を押して設定を完了します。これでCData Sync が同期ジョブをスケジュール実行してくれます。ユーザーはダッシュボードで同期ジョブの状態をチェックするだけです。

差分更新

CData Sync では、主要なデータソースでは、差分更新が可能です。差分更新では、最後のジョブ実行時からデータソース側でデータの追加・変更があったデータだけを同期するので、レプリケーションのクエリ・通信のコストを圧倒的に抑えることが可能です。

差分更新を有効化するには、ジョブの［概要］タブから「差分更新」パネルを選び、［⚙設定］ボタンをクリックします。［開始日］と［レプリケーション間隔］を設定して、［保存］します。

SQL での取得データのカスタマイズ

CData Sync は、デフォルトではShipStation のオブジェクト / テーブルをそのままSqlite に複製しますが、ここにSQL、またはdbt 連携でのETL 処理を組み込むことができます。テーブルカラムが多すぎる場合や、データ管理の観点から一部のカラムだけをレプリケーションしたり、さらにデータの絞り込み（フィルタリング）をしたデータだけをレプリケーションすることが可能です。

ジョブの［概要］タブ、［タスク］タブへと進みます。選択されたタスク（テーブル）の［▶］の左側のメニューをクリックし、［編集］を選びます。タスクの編集画面が開きます。

UI からカラムを選択する場合には、［カラム］タブから［マッピング編集］をクリックします。レプリケーションで使用しないカラムからチェックを外します。

SQL を記述して、フィルタリングなどのカスタマイズを行うには、［クエリ］タブをクリックし、REPLICATE ［テーブル名］の後に標準SQL でフィルタリングを行います。

ShipStation からSqlite へのデータ同期には、ぜひCData Sync をご利用ください

このようにノーコードで簡単にShipStation のデータをSqlite にレプリケーションできます。データ分析、AI やノーコードツールからのデータ利用などさまざまな用途でCData Sync をご利用いただけます。30日の無償トライアルで、シンプルでパワフルなデータパイプラインを体感してください。

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

CData Sync の 導入事例を併せてご覧ください。