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

古川えりか
古川えりか
コンテンツスペシャリスト
CData ODBC ドライバとSQL Server 2019 のPolyBase を使って、リアルタイムApprovalMax に外部データソースとしてアクセス。



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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

まず、Profile 接続プロパティをディスク上の ApprovalMax プロファイルの場所に設定します（例：C:\profiles\ApprovalMax.apip）。次に、ProfileSettings 接続プロパティを ApprovalMax の接続文字列に設定します（以下を参照）。

ApprovalMax API プロファイル設定

ApprovalMax Public API では、OAuth 2.0 の認可コードフローで認証を行います。自分のデータに接続するだけでなく、他のユーザーが各自のデータに接続できるようにすることも可能です。

まず、ApprovalMax に OAuth アプリケーションを登録する必要があります。ApprovalMax Developer Portal（https://developer.approvalmax.com/applications）にサインインし、新しいアプリケーションを作成します。OAuth アプリケーションには Client ID と Client Secret が割り当てられます。また、Redirect URI（Callback URL）を少なくとも1つ登録しておく必要があります。

Public API を利用するには、ApprovalMax の Premium サブスクリプション（または有効なトライアル）が必要です。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme：OAuth に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId：ApprovalMax Developer Portal のアプリケーション設定に表示される Client ID に設定します。
  • OAuthClientSecret：ApprovalMax Developer Portal のアプリケーション設定に表示される Client Secret に設定します。
  • CallbackURL：アプリケーション設定で登録した Redirect URI に設定します。
  • Scope：（オプション）デフォルトの OAuth スコープを上書きします。デフォルト値の openid offline_access https://www.approvalmax.com/scopes/public_api/read は、このプロファイルのすべてのテーブルへの読み取り専用アクセスを許可し、リフレッシュトークンを有効にします。スコープを絞り込む際は、最小権限の原則に従ってください。

OAuth の Authorization URL は https://identity.approvalmax.com/connect/authorize、Token URL は https://identity.approvalmax.com/connect/token です。グラントタイプは authorization_code と refresh_token の両方に対応しています。

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

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

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

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

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

CREATE MASTER KEY ENCRYPTION BY PASSWORD = 'password';

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

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

Note：ApprovalMax は認証にUser やPassword を必要としないため、IDENTITY とSECRET に任意の値を使用できます。

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

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

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

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

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

ApprovalMax の外部テーブルを作成

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

Table definition in the DSN Configuration Wizard (Salesforce is shown)

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

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

CREATE EXTERNAL TABLE UserProfiles(
  UserId [nvarchar](255) NULL,
  Email [nvarchar](255) NULL,
  ...
) WITH (
  LOCATION='UserProfiles',
  DATA_SOURCE=cdata_api_source
);

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

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

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

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

はじめる準備はできましたか？

API Driver で ApprovalMax のライブデータに接続

ApprovalMax に接続

この記事の内容

関連記事