各製品の資料を入手。
詳細はこちら →
製品をチェック
SQL Server からJSON へストアドプロシージャで自動連携：SQL Gateway
SQL Server のCDC 機能とストアドプロシージャを使って、リンクサーバー経由でJSON のデータを定期的に更新する方法
最終更新日：2022-03-22
こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。
シナリオ
SQL Serverにある既存テーブルの更新された値を、JSON に自動的に取り込んでいきます。構成は、JSON とSQL Server の間にSQL Gateway を配置し、SQL Gateway からデータソースへのアクセスはHTTP リクエスト、SQL Gateway からクライアントへはTDS プロトコル（SQL Server）でアクセスできるようにします。
SQL Gateway を使うことで、SQLServer のリンクサーバー経由やMySQL へ接続できるツール、サービスなどからもSaaS にアクセスすることが可能になります。もちろん参照だけでなく更新も可能です。
手順
やることは大枠でこちらの内容です。
- CData ODBC ドライバインストール & DSN 設定
- SQL Gateway TDS プロトコルI/F を作成
- SQL Server リンクサーバーを作成
- SQL Server CDC 機能をオンにする
- SQL Server 更新用ストアドプロシージャの作成
- SQL Server エージェントでスケジュール設定
CData ODBC ドライバとは？
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- JSON をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにJSON のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてJSON の接続を設定、2.SQL Server 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとJSON への接続設定
まずは、本記事右側のサイドバーからJSON ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
CData ODBC ドライバをインストールすると SQL Gateway もあわせてインストールされるようになっています。ではこちらのリンクからJSON をクリックして、インストーラーをダウンロードします。ダウンロードボタンをクリックしてJSON
ODBC Driver
をダウンロードします。
ダウンロードしたJSONODBCDriver.exe をダブルクリックしてインストールを開始します。
インストール自体はデフォルトのまま進んで構いません。インストール後にDSN 設定画面が開きます。
- 接続プロパティの指定がまだの場合は、DSN （データソース名）で行います。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN
を作成および設定できます。一般的な接続プロパティは以下のとおりです：
- URI
- DataModel
Microsoft ODBC データソースアドミニストレーターで必要なプロパティを設定する方法は、ヘルプドキュメントの「はじめに」をご参照ください。
データソースへの認証については、ヘルプドキュメントの「はじめに」を参照してください。CData 製品は、JSON API を双方向データベーステーブルとして、JSON ファイルを読み取り専用ビュー（ローカル ファイル、一般的なクラウドサービスに保存されているファイル、FTP サーバー）としてモデル化します。HTTP Basic、Digest、NTLM、OAuth、FTP などの主要な認証スキームがサポートされています。詳細はヘルプドキュメントの「はじめに」を参照してください。
URI を設定して認証値を入力したら、DataModel を設定してデータ表現とデータ構造をより厳密に一致させます。
DataModel プロパティは、データをどのようにテーブルに表現するかを制御するプロパティで、次の基本設定を切り替えます。
- Document（デフォルト）：JSON データのトップレベルのドキュメントビューをモデル化します。CData 製品 は、ネストされたオブジェクト配列を集約されたJSON オブジェクトとして返します。
- FlattenedDocuments：ネストされた配列オブジェクトと親オブジェクトを、単一テーブルに暗黙的に結合します。
- Relational：階層データから個々の関連テーブルを返します。テーブルには、親ドキュメントにリンクする主キーと外部キーが含まれています。
リレーショナル表現の設定についての詳細は、ヘルプドキュメントの「JSON データのモデリング」を参照してください。また、以下の例で使用されているサンプルデータも確認できます。データには人や所有する車、それらの車に行われたさまざまなメンテナンスサービスのエントリが含まれています。
Amazon S3 内のJSON への接続
URI をバケット内のJSON ドキュメントに設定します。さらに、次のプロパティを設定して認証します。
- AWSAccessKey：AWS アクセスキー（username）に設定。
- AWSSecretKey：AWS シークレットキーに設定。
Box 内のJSON への接続
URI をJSON ファイルへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。
Dropbox 内のJSON への接続
URI をJSON ファイルへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。 URI=dropbox://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
SharePoint Online SOAP 内のJSON への接続
URI をJSON ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。
SharePoint Online REST 内のJSON への接続
URI をJSON ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。
FTP 内のJSON への接続
URI をJSON ファイルへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。
Google Drive 内のJSON への接続
デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。
ここまでで、CData JSON ODBC Driver の設定が完了しました。続いてはSQL Gateway の設定に入っていきます。
SQL Gateway でTDS プロトコルI/F を作成
Windows メニューにある SQL Gateway クリックして起動します。
SQL Gateway が起動されたらこのようなコンソール画面が表示されます。最初に「サービス」タブから追加ボタンをクリックします。
以下の内容で設定します。
- サービス名：任意
- I/F：サービス名下のラジオボタンでTDS（SQL Server）を選択
- データソース：先ほど設定したDSN
- ポート：未使用のもの
外部からこの SQL Gateway にアクセスする際のユーザー情報を作成します。
作成後は「変更を保存」→「開始」の順でボタンをクリックします。サービスが正常に開始されると、このように緑色のランプが点灯します。
これで データソースからSQL Gateway 間の接続設定と、TDS プロトコルでのインタフェース設定が完了しました。
リンクサーバーの作成
次にSQL Server とSQL Gateway をつなぐために、リンクサーバーを作成していきます。
SSMS で対象の SQL Server に接続し、「サーバーオブジェクト」->「リンクサーバー」から右クリックでリンクサーバーの新規作成を行います。
- リンクサーバー名：任意
- サーバーの種類：その他
- プロバイダー：SQL Server Native Client
- データソース：SQL Gateway を起動しているインスタンスとポート
「インスタンス,ポート」の書き方。 - カタログ：SQL Gateway で指定したDSN
セキュリティに移動して、SQL Gateway
で作成したユーザー情報を入力して設定は完了です。
これでJSON のオブジェクトがリンクサーバーにテーブルとして表示されるようになりました。
SQL Server の設定（CDC）
まずは CDC（Change Data Capture）
機能をオンにしていきます。ちなみにこの CDC
とは、各テーブルのデータの変更情報を保持してくれる機能です。
※CDC はStandard Edition 以上、もしくはDeveloper Edition
で利用可能です。
今回はこのCDC 機能を使って変更データを抽出し、JSON に連携していきます。
CDC 機能を利用するデータベースを指定して以下のSQL を実行します。
USE cdata;
GO
EXECUTE sys.sp_cdc_enable_db;
GO
CDC の対象とするテーブルを設定します。
EXEC sys.sp_cdc_enable_table
@source_schema = N'dbo',
@source_name = N'顧客データ_東北支店',
@role_name = N'cdc_role',
@supports_net_changes = 1
GO
各種パラメータの説明はMicrosoft の公式ドキュメントをご参照ください。上記以外にも設定できるようです。
これで対象 DB
のシステムテーブルに、変更情報を保持してくれるテーブルが表示されました。
何も変更していない状態では、dbo_顧客データ_東北支店_CT
テーブルのレコードはない状態です。
CDC 対象の顧客データ_東北支店
テーブルにあるメールアドレス列の値を変更してみます。
もう一度、dbo_顧客データ_東北支店_CT テーブルを参照すると変更前後のレコードが格納されました。ちなみに$operation=3 で更新前、4で更新後となります。
これで SQL Server で変更したデータを確認することが出来るようになりました！
ストアドプロシージャの作成
シンプルに CDC テーブルの Name という項目だけを使用して、それをリンクサーバーの [JSON].[顧客管理（営業支援パック）] テーブルに Insert、Delete、Update で連携するということをやってみます。
CREATE PROCEDURE JSONSP
AS
BEGIN
SET ANSI_NULLS ON
SET ANSI_WARNINGS ON
--カーソルの値を取得する変数宣言
DECLARE @Id varchar(50)
DECLARE @email varchar(50)
DECLARE @Operation int
--カーソル定義
DECLARE CUR_1 CURSOR FOR
SELECT a.[RecordId], a.[メールアドレス],a.[__$operation]
FROM [cdata].[cdc].[dbo_顧客データ_東北支店_CT] AS a,
(SELECT[RecordId] , MAX([__$seqval]) AS seqval
FROM [cdata].[cdc].[dbo_顧客データ_東北支店_CT]
GROUP BY [RecordId]) AS b
WHERE a.[RecordId] = b.[RecordId]
AND a.[__$seqval] = b.seqval
--'3'は更新前レコード
AND a.[__$operation] <> '3'
--カーソルオープン
OPEN CUR_1;
FETCH NEXT FROM CUR_1
INTO @Id,@email,@Operation;
WHILE @@FETCH_STATUS = 0
BEGIN
-- 削除レコードの場合
IF @Operation = 1
BEGIN
DELETE FROM [JSON_GATEWAY].[CData JSON Sys].[JSON].[顧客管理（営業支援パック）] WHERE
RecordId=@Id;
END
-- 新規レコードの場合
ELSE IF @Operation = 2
BEGIN
INSERT INTO [JSON_GATEWAY].[CData JSON Sys].[JSON].[顧客管理（営業支援パック）]
([メールアドレス])
Values(@email);
END
-- 更新レコードの場合
ELSE IF @Operation = 4
BEGIN
UPDATE [JSON_GATEWAY].[CData JSON Sys].[JSON].[顧客管理（営業支援パック）] SET
[メールアドレス] =
@email
WHERE
RecordId=@Id;
END
--次のレコード
FETCH NEXT FROM CUR_1
INTO @Id,@email,@Operation;
END
--カーソルクローズ
CLOSE CUR_1;
DEALLOCATE CUR_1;
--CDC変更テーブルのレコード削除
Truncate table [cdc].[dbo_顧客データ_東北支店_CT]
END
スケジュール設定
最後にSQL Server
エージェントでストアドプロシージャのスケジュール実行を設定します。
ステップで新規作成から、先ほど作成したストアドプロシージャを実行するよう設定します。
実行タイミングを設定します。今回は夜中に毎日実行されるようスケジューリングしました。
設定後はこのように次にジョブが実行される時間やステータスなどが表示されています。
これで設定が完了しました！
SQL Server のデータを更新
以下は変更テーブルの中身です。赤枠内のレコードが
リンクサーバーを介してJSON に反映される想定です。
赤枠レコードの内訳は、
- 1行目：削除レコード（__$operation:1）
- 2行目：更新前レコード（__$operation:3）
- 3行目：更新後レコード（__$operation:4）
- 4行目：追加レコード （__$operation:2）
ではこれでAM 3:00に実行されるのを待ってみると、ジョブが実行されました。
リンクサーバーの[JSON].[顧客管理（営業支援パック）]
テーブルを参照すると、先ほど確認したレコードが削除も含めて反映されていました。
これであとはこのまま起動しておくだけで、SQL Server で更新したレコードをもとにJSON が更新されるようになりました。
おわりに
いかがでしたでしょうか。SQL Server の CDC 機能とストアドプロシージャ、リンクサーバーでJSON に自動連携できるようになりました。
CData ODBC Driver for JSON は 30日間の無償評価版がご利用可能です。こちらから をぜひお試しください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
