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

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

Sage X3 Cloud のデータへの接続

まだ設定していない場合は、データソース名（DSN）に必要な接続プロパティの値を指定します。DSN の設定には、Microsoft ODBC Data Source Administrator を使用できます。これはドライバーインストールの最終手順でもあります。Microsoft ODBC Data Source Administrator を使ったDSN の作成・設定方法については、ヘルプドキュメントの「Getting Started」の章を参照してください。

Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

• URL：Sage X3 Cloud インスタンスのベース URL。
• OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
• OAuthClientId：OAuth アプリケーションのクライアント ID。
• OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
• Audience：トークンリクエストで使用する API の Audience 値。
• XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
• Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
• Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

SQL Gateway の設定

Sage X3 Cloud のデータを仮想的なMySQL データベースとして利用できるように接続を設定するには、SQL Gateway の概要を参照してください。クライアントからのMySQL リクエストを受け付けるMySQL リモーティングサービスを設定します。このサービスは、SQL Gateway のUI で設定できます。

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

サービスの設定と起動が完了したら、FEDERATED サーバーを作成しましょう。これにより、FEDERATED テーブルの作成が簡単になります。

FEDERATED サーバーの作成

以下のステートメントでは、ODBC Driver for SageX3Cloud を基にしたFEDERATED サーバーを作成します。FEDERATED サーバーのユーザー名とパスワードは、SQL Gateway のUsers タブで定義したユーザーアカウントと一致させる必要があります。

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

FEDERATED テーブルの作成

先ほど作成したサーバーを使ってFEDERATED テーブルを作成するには、CONNECTION キーワードを使い、FEDERATED サーバーの名前とリモートテーブル（BPCUSTOMER）を指定します。FEDERATED テーブルを作成するステートメントは、以下のテンプレートを参考にしてください。

CREATE TABLE fed_bpcustomer (
  ...,
  bpcnum  TYPE(LEN),
  bpcnam  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedSageX3Cloud/bpcustomer';

注：FEDERATED テーブルのテーブルスキーマは、リモートテーブルのスキーマと完全に一致させる必要があります。任意のMySQL クライアントを使ってMySQL リモーティングサービスに直接接続し、SHOW CREATE TABLE クエリを実行すれば、テーブルスキーマを取得できます。

クエリの実行

これで、MySQL に接続できる任意のツールからSage X3 Cloud のFEDERATED テーブルに対してクエリを実行できるようになりました。ローカルテーブルのデータとSage X3 Cloud のデータをJOIN したい場合には、特に便利です。以下の例を参考にしてください。

SELECT
  fed_bpcustomer.bpcnum,
  local_table.custom_field
FROM
  local_table
JOIN
  fed_bpcustomer
ON
  local_table.foreign_bpcnum = fed_bpcustomer.bpcnum;