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

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

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

Zendesk データへの接続

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.

Connecting to Zendesk

接続するには、URL を設定して認証を提供します。URL は、Zendesk Support のURL：https://{subdomain}.zendesk.com です。

Zendesk への接続

Zendesk は、Basic 認証またはOAuth 2 認証標準を利用しています。

ベーシック認証

ベーシック認証では、E メールアドレスとパスワード、もしくは、E メールアドレスとAPI token で接続します。User をE メールアドレスに設定し、次の方法でPassword とAPI Token を提供します。

• Admin、Channels、API でZendesk Support Admin からパスワードを有効化します。
• Zendesk Support Admin からAdmin->Channels->API と操作し、API token を管理します。同時に複数のトークンを有効化させることが可能です。

OAuth 認証

詳細はヘルプドキュメントを参照してください。

SQL Gateway の設定

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

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

CREATE TABLE fed_tickets (
  ...,
  id  TYPE(LEN),
  subject  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedZendesk/tickets';

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

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