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

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

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

ShipStation のデータへの接続

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.

ShipStation 接続プロパティの取得・設定方法

ShipStation への接続には、BASIC 認証標準を使います。

1. ShipStation アカウントにログインします。
2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
3. ［アカウント］->［API 設定］をクリックします。
4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

ShipStation への認証

• APIKey：［API 設定］ページのAPI Key に設定します。
• APISecret：［API 設定］ページのSecret key に設定します。

SQL Gateway の設定

See the SQL Gateway Overview to set up connectivity to ShipStation のデータ 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.

ShipStation データ の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 ShipStation. 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 fedShipStation
FOREIGN DATA WRAPPER mysql
OPTIONS (USER 'sql_gateway_user', PASSWORD 'sql_gateway_passwd', HOST 'sql_gateway_host', PORT ####, DATABASE 'CData ShipStation 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 (Tags). Refer to the following template for the statement to create a FEDERATED table:

CREATE TABLE fed_tags (
  ...,
  id  TYPE(LEN),
  color  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedShipStation/tags';

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 ShipStation 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 ShipStation. Refer to the following example:

SELECT
  fed_tags.id,
  local_table.custom_field
FROM
  local_table
JOIN
  fed_tags
ON
  local_table.foreign_id = fed_tags.id;