Smaregi データをSQL Server に同期(キャッシュ)する方法

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Smaregi ODBC Driver

Smaregi ODBC ドライバーは、ODBC 接続をサポートする任意のアプリケーションからライブなスマレジデータに直接接続できる強力なツールです。標準のODBC ドライバーインタフェースを使用して、データベースのようにスマレジにアクセスし、商品、在庫、発送状況などの読み出し、書き込み、および更新を実行できます。



キャッシュ機能を使って、Smaregi の任意のエンドポイントをSQL Server にキャッシュ同期



Smaregi データをDB にコピーするニーズは多いです。例えば、データのバックアップのため、 データをDB にデータレイク的に格納して他のアプリケーションやBI、ETL ツールから連携利用するなどです。
ただし、JSON やXML 形式であったりスキーマレスなデータなどを、DB に格納できるようにスキーマ定義をしながらデータを同期することは大きな手間です。 しかも、SaaS やNoSQL などのデータはスキーマレスであったり、スキーマが頻繁に変更されます。
CData Driver 技術では、Smaregi データをテーブルにモデル化し、スキーマを付与してDB にへの格納を容易にします。 本記事では、CACHE コマンドだけで、SQL Server にSmaregi データの同期を取る方法を説明します。

※製品について詳しい情報をご希望の方は以下からお進みください。

同期先となるデータベースの準備

この例では、SQL Server を使います。難しい手順は不要で、SQL Server に任意の名前の新しい同期DB を作成しておくだけです。

ODBC Driver for Smaregi のインストールとSmaregi への接続

ODBC 接続プロパティの指定がまだの場合は、DSN (データソース名)で接続設定を行います。 Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。 ODBC ドライバーのインストール完了時にODBC DSN 設定画面が立ち上がります。 Microsoft ODBC データソースアドミニストレーターを開いて設定を行うことも可能です。 必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。

スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。

  • スマレジにログイン後、[設定]->[システム連携]->[スマレジAPI 設定]に移動します。
  • [API受信設定]セクションにある[受信機能を利用する]を[利用する]に変更し、[アクセストークンの生成]をクリックし、AccessToken を取得します。
  • 次に必要なAPI アクセスを有効にするため、[機能設定]セクションで必要な機能を[利用する]に変更します。

ContractId: アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken: 受信設定セクションのアクセストークン。

通常のDSN 設定に加え、キャッシュ関連項目の設定が必要です:
Cache Connection:以下をセミコロン区切りで入力
Cache Provider:SQL Server ではSystem.Data.SqlClient

Server=server name;Database=database name;User ID=your id;Password=password;

Visual Studio からキャッシュを実行

Visual Studio のサーバーエクスプローラーから「データ接続」を右クリックして「接続の追加」を選択します。
データソース選択画面で「Microsoft ODBC データソース」を選択します。

サーバーエクスプローラーには、「ODBC.Smaregi.CData」というコネクションができています。 展開するとSmaregi データがテーブルよびビューとしてモデル化されて表示されます。 これらのオブジェクトは通常のSQL で操作することができます。

キャッシュクエリの実行

以下のキャッシュコマンドを作成し、実行します。 実行時にクエリテキストエラーが出ても気にせず続行してください。

CACHE SELECT * FROM "Target Table"

キャッシュ結果をSQL Server で確認

データベースの下にkintone の選択したアプリが同期されています。キレイにDB 向けにスキーマも付いてます。普通にSQL でアプリケーション内で使ってください。