MySQL のFederated Table としてUM SaaS Cloud データを連携利用する

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

SQL Gateway を使って、MySQL リモーティングサービスを作成し、UM SaaS Cloud のMySQL Federated Table を構築できます。CData ODBC Driver for UMSaaSCloud のMySQL インターフェースのdeamon になります。サービス起動後、MySQL のFEDERATED ストレージエンジンを使ってサーバーおよびテーブルを作成します。UM SaaS Cloud データ をMySQL テーブルのように使いましょう。

UM SaaS Cloud データへの接続

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

UM SaaS Cloud 接続プロパティの取得・設定方法

デフォルトでは、本製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

UM SaaS Cloud への認証

UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

Basic 認証

Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。

デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。

SQL Gateway の設定

See the SQL Gateway Overview to set up connectivity to UM SaaS Cloud データ as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

UM SaaS Cloud データ のFEDERATED サーバーおよびテーブルを作成

After you have configured and started the service, create a FEDERATED server to simplify the process of creating FEDERATED tables:

FEDERATED サーバーの作成

The following statement will create a FEDERATED server based on the ODBC Driver for UMSaaSCloud. Note that the username and password of the FEDERATED server must match a user account you defined on the Users tab of the SQL Gateway.

CREATE SERVER fedUMSaaSCloud
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData UMSaaSCloud Sys');

FEDERATED テーブルの作成

To create a FEDERATED table using our newly created server, use the CONNECTION keyword and pass the name of the FEDERATED server and the remote table (Account). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_account (
  ...,
  billingstate  TYPE(LEN),
  name  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedUMSaaSCloud/account';

NOTE: The table schema for the FEDERATED table must match the remote table schema exactly. You can always connect directly to the MySQL remoting service using any MySQL client and run a SHOW CREATE TABLE query to get the table schema.

クエリの実行

You can now execute queries to the UM SaaS Cloud FEDERATED tables from any tool that can connect to MySQL, which is particularly useful if you need to JOIN data from a local table with data from UM SaaS Cloud. Refer to the following example:

SELECT 
  fed_account.billingstate, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_account 
ON 
  local_table.foreign_billingstate = fed_account.billingstate;