PolyBase で外部データソースとしてZendesk を連携利用

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

SQL Server のPolyBase は、データベーステーブルをクエリするTransact-SQL 構文を使って、外部データにクエリする仕組みです。 CData ODBC Driver for Zendesk を組み合わせて使うことで、SQL Server データと同じようにZendesk へのアクセスが可能です。 本記事では、外部データソースと外部テーブルの作成から、T-SQL クエリを使ってリアルタイムZendesk のデータへ接続を認可するところまで説明します。

CData ODBC ドライバーは、ドライバーに組み込まれた最適化されたデータ処理により、PolyBase でリアルタイムZendesk のデータを送受信するための圧倒的なパフォーマンスを提供します。SQL Server からZendesk に複雑なSQL クエリを発行すると、ドライバーはフィルタや集計などのサポートされているSQL 操作をZendesk に直接プッシュダウンし、組み込みSQL エンジンを利用して、サポートされていない操作（一般的にはSQL 関数とJOIN 操作） をクライアント側で処理します。また、PolyBase を使用することで、単一のクエリを使用して分散ソースからデータをプルし、SQL Server データをZendesk と結合することもできます。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

1. Zendesk をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
2. 多様なアプリケーション、ツールにZendesk のデータを連携
3. ノーコードでの手軽な接続設定
4. 標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてZendesk の接続を設定、2.PolyBase 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとZendesk への接続設定

まずは、本記事右側のサイドバーからZendesk ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

未指定の場合は、初めにODBC DSN（data source name）で接続プロパティを指定します。ドライバーのインストールの最後にアドミニストレーターが開きます。Microsoft ODBC Data Source Administrator を使用して、ODBC DSN を作成および構成できます。PolyBase を使用してSQL Server に外部データソースを作成するには、System DSN を構成します。（CData Zendesk Sys は自動的に作成されます。）

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

Zendesk に接続するには、https://{subdomain}.zendesk.com の形式でURL（Zendesk Support URL）を設定します。接続後、次のセクションの説明に従ってユーザー認証を行います。

また、TicketMetrics テーブルのアーカイブデータを扱うユーザーは、UseIncrementalAPI プロパティをTrue に設定する必要があります。

Zendesk への認証

Zendesk は、Zendesk インスタンスの設定に応じて、3種類の認証をサポートします。API トークン認証、OAuth 認証、Basic 認証（レガシー）です。

API トークン認証

API トークン認証を使用する場合は、E メールアドレスとApiToken を指定します。 AuthScheme をAPIToken に、User をE メールアドレスに設定し、Zendesk Support の管理画面で以下の設定を行います。

1. Token アクセスを有効にします。
2. Admin -> Channels-> API で、API トークンを管理します。一度にアクティブにできるトークンは1つだけです。トークンを削除すると、そのトークンは永久に無効化されます。

その他の認証方法についてはヘルプドキュメントを参照してください。

［接続のテスト］をクリックして、DSN がZendesk に正しく接続できているかを確認します。［テーブル］タブに移動し、Zendesk のテーブル定義を確認します。

Zendesk のデータの外部データソースを作成

接続を構成したのち、外部データソースのマスター暗号化キーと資格情報データベースを作成する必要があります。

マスター暗号化キーの作成

以下のSQL コマンドを実行して新しいマスターキー［ENCRYPTION］を作成し、外部データソースの資格情報を暗号化します。

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

資格情報データベースの作成

以下のSQL コマンドを実行してZendesk に接続されている外部データソースの資格情報を作成します。

Note：IDENTITY とSECRET はZendesk のUser プロパティとPassword プロパティに対応しています。

CREATE DATABASE SCOPED CREDENTIAL zendesk_creds
WITH IDENTITY = 'username', SECRET = 'password';

Zendesk の外部データソースを作成

以下のSQL コマンドを実行し、以前作成したDSN と資格情報を使用して、PolyBase でZendesk の外部データソースを作成します。

Zendesk の場合、SERVERNAME を［localhost］または［127.0.0.1］に設定し、PORT を空のままにします。PUSHDOWN は、デフォルトでON に設定されているため、ODBC Driver は、サーバー側の処理を利用して複雑なクエリを実行できます。

CREATE EXTERNAL DATA SOURCE cdata_zendesk_source
WITH (
  LOCATION = 'odbc://SERVERNAME[:PORT]',
  CONNECTION_OPTIONS = 'DSN=CData Zendesk Sys',
  -- PUSHDOWN = ON | OFF,
  CREDENTIAL = zendesk_creds
);

Zendesk の外部テーブルを作成

外部データソースを作成したら、CREATE EXTERNAL TABLE ステートメントを使用してSQL Server インスタンスからZendesk にリンクします。テーブルカラムの定義は、CData ODBC Driver for Zendesk によって公開されているものと一致しなければなりません。DSN Configuration Wizard の［テーブル］タブを参照し、テーブルの定義を確認できます。

CREATE TABLE ステートメントのサンプル

以下は、Zendesk Tickets に基づいて外部テーブルを作成するステートメントの一例です。

CREATE EXTERNAL TABLE Tickets(
  Id [nvarchar](255) NULL,
  Subject [nvarchar](255) NULL,
  ...
) WITH (
  LOCATION='Tickets',
  DATA_SOURCE=cdata_zendesk_source
);

SQL Server インスタンスでZendesk の外部テーブルを作成すると、ローカルデータとリモートデータを同時にクエリできるようになります。CData ODBC Driver に組み込まれているクエリ処理により、可能な限り多くのクエリ処理がZendesk にプッシュされることで、ローカルのリソースと計算リソースが解放されます。ODBC Driver for Zendesk の30日間無料トライアルをダウンロードし、SQL Server データでリアルタイムZendesk のデータを使い始めましょう。

Zendesk からPolyBase へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。