MySQL Workbench からスマレジ のデータをクエリする方法

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

ODBC Driver for Smaregi とSQL Gateway を使用することで、MySQL インターフェースを使ってスマレジ にクエリを実行できます。この記事では、MySQL Workbench からスマレジ データにSQL クエリを投げてデータを取得する方法をご紹介します。

CData ODBC ドライバとは？

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

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

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

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

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

未指定の場合は、データソース名（DSN）で必要な接続プロパティの値を指定します。ドライバーのインストールの最後にODBC アドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターでDSN を作成及び設定する方法については、ヘルプドキュメントの［はじめに］チャプターを参照してください。

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

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

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

SQL Gateway を構成する

スマレジ への接続を仮想MySQL データベースとして設定する方法については、SQL Gateway の解説記事 を参照してください。クライアントからのMySQL リクエストを受けるMySQL リモートサービスを構築します。このサービスは、SQL Gateway のUI で構成できます。

MySQL Workbench からスマレジ をクエリ

以下のステップでは、MySQL Workbench からSQL Gateway で作成された仮想スマレジ データベースに接続し、スマレジ データをリアルタイムで操作するための基本的なクエリを発行する方法を説明します。

SQL Gateway を介してスマレジ に接続

1. MySQL Workbench で、［add a new MySQL connection］をクリックします。
2. 接続（CData SQL Gateway for Smaregi）に名前を付けます。
3. Hostname、Port、Username のパラメータを設定し、SQL Gateway に接続します。
4. Store in Vault をクリックしてパスワードを設定し、保存します。
5. Test Connection をクリックして接続が正しく構成されていることを確認し、OK をクリックします。

スマレジ データをクエリしてみる

1. 作成した接続（CData SQL Gateway for Smaregi）を開きます。
2. ［File］->［New Query Tab］と進みます。
3. SELECT * FROM `CData Smaregi Sys`.Products; のようなスマレジ データを取得するSQL を書いて、実行します。
4. 無事、スマレジ のデータが取得できました。

おわりに

MySQL Workbench からリアルタイムスマレジ データにアクセスすることで、MySQL データベースと同じようにスマレジ をクエリおよび更新できます。CData ODBC Driver for Smaregi とCData SQL Gateway の30日の無償評価版はこちらです。

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