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

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

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

Pipedrive データへの接続

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.

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

Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

Basic

1. PipeDrive の右上にあるアカウント名をクリックします。
2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
3. API トークンを控えておきます。
4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。

以下を設定してPipedrive へ認証します。

• APIToken：控えておいたAPI トークンに設定。
• CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
• AuthScheme：Basic に設定。

API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。

OAuth

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

SQL Gateway の設定

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

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

CREATE TABLE fed_deals (
  ...,
  personname  TYPE(LEN),
  useremail  TYPE(LEN),
  ...,
)
ENGINE=FEDERATED
DEFAULT CHARSET=latin1
CONNECTION='fedPipedrive/deals';

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

SELECT 
  fed_deals.personname, 
  local_table.custom_field 
FROM 
  local_table 
JOIN 
  fed_deals 
ON 
  local_table.foreign_personname = fed_deals.personname;