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

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

Gumroad のデータへの接続

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

OAuth 認証の設定

Gumroad への認証では、OAuth 2.0 標準を使って自分自身のデータに接続する場合はもちろん、他のユーザーが各自のデータに接続できるようにする場合にも利用できます。これが推奨される認証方式です。

まず、Gumroad に OAuth アプリケーションを登録する必要があります。https://app.gumroad.com/settings/advanced の Gumroad アカウント設定にアクセスし、Applications セクションに移動して OAuth アプリケーションを作成できます。

以下の接続プロパティを設定して接続を確立してください：

• AuthScheme：OAuth に設定します。
• InitiateOAuth：GETANDREFRESH に設定します。CData API Profile for Gumroad が OAuth プロセスを自動的に進め、アクセストークンを取得します。
• OAuthClientID：アプリ設定で指定された client_id に設定します。
• OAuthClientSecret：アプリ設定で指定された client_secret に設定します。
• CallbackURL：アプリ設定で指定したリダイレクト URI に設定します。

接続文字列の例

Profile=C:\profiles\Gumroad.apip;AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;

SQL Gateway の設定

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

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

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

FEDERATED サーバーの作成

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

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

FEDERATED テーブルの作成

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

CREATE TABLE fed_customfields (
  ...,
    TYPE(LEN),
    TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedAPI/customfields';

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

クエリの実行

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

SELECT
  fed_customfields.,
  local_table.custom_field
FROM
  local_table
JOIN
  fed_customfields
ON
  local_table.foreign_ = fed_customfields.;