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

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

ODBC Driver for API と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 ドライバのインストールとユビレジ への接続設定

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

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

Ubiregi に接続するには、Ubiregi API トークンとMenuId が必要です。API トークンはUbiregi のシステム統合ページで生成できます。生成したトークンは、ProfileSettings API Key 接続プロパティに設定してください。また、自身のUbiregi メニューページのURL「https://ubiregi.com/a/setting/menus/{MenuId}」でMenuId を確認できます（こちらの例の{MenuId} の箇所）。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

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 API）に名前を付けます。
3. Hostname、Port、Username のパラメータを設定し、SQL Gateway に接続します。
4. Store in Vault をクリックしてパスワードを設定し、保存します。
5. Test Connection をクリックして接続が正しく構成されていることを確認し、OK をクリックします。

ユビレジ のデータをクエリしてみる

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

おわりに

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

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