JSON データのPostgreSQL インターフェース

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

インターネット上には膨大な数のPostgreSQL クライアントが存在します。標準ドライバーからBI、Analytics ツールまで、PostgreSQL はデータアクセス用の一般的なインターフェースです。 ODBC Drivers に含まれるSQL Gateway を使用することで、どの標準クライアントからでも接続が可能なPostgreSQL エントリポイントを作成することができるようになります。

Windows でPostgreSQL データベースとしてJSON データにアクセスするには、CData SQL Gateway およびODBC Driver for JSON、EnterpriseDB のMySQL 外部データラッパーを使用します。この記事では、外部データラッパーをVisual Studio でコンパイルして拡張機能としてインストールし、PostgreSQL Server からJSON データをクエリします。

CData ODBC ドライバとは？

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

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

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

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

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

接続プロパティが未設定の場合は、まずデータソースのODBC DSN で設定します。これはドライバーインストール時の最後の手順にあたります。Microsoft ODBC データソースアドミニストレーターを使ってODBC DSN を作成および設定できます。

データソースへの認証については、ヘルプドキュメントの「はじめに」を参照してください。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 への接続」を参照してください。

リモートサービスを開始する

MySQL リモートサービスは、クライアントからのMySQL 接続の受信を待機するデーモンプロセスです。CData SQL Gateway でMySQL リモートサービスを構成するには、SQL Gateway の概要にあるセットアップガイド を参照してください。

MySQL 外部データラッパーを構築する

外部データラッパー（FDW）は、PostgreSQL を再コンパイルすることなく拡張機能としてインストールできます。Unix ベースのシステムでPostgreSQL を実行している場合、PostgreSQL Extension Network（PGXN）を使用してFDW（mysql_fdw）をインストールできます。Windows でPostgreSQL を実行している場合は、拡張機能をコンパイルして最新バージョンを使用していることを確認してください。以下のステップに従って、Visual Studio から拡張機能を構築するのに必要な編集を行います。

前提条件を取得する

外部データラッパーを構築するために、以下を行います。

• PostgreSQL をインストールします。この例では、インストールにPostgreSQL 9.4 を使用します。
• PostgreSQL の64 ビットインストールを使用している場合、PostgreSQL ソースからlibintl.h を取得します。64 ビットのPostgreSQL インストーラーは、現時点ではlibintl.h を含みません。
• mysql_fdw 外部データラッパーへのソースを、EnterpriseDB から取得します。
• MySQL Connector C をインストールします。この例では、MySQL Connector C 6.1 を使用します。

プロジェクトを構成する

必要なソフトウェアとソースコードを取得したら、Visual Studio で拡張機能をコンパイルする準備ができました。以下のステップに従い、mysql_fdw ソースを使用してプロジェクトを作成します。

1. Visual Studio で、新しい空のC++ プロジェクトを作成します。
2. Solution Explorer において、「Source Files」を右クリックし、「Add」->「Existing Item」をクリックします。ファイルエクスプローラーで、mysql_fdw からすべての.c ファイルと.h ファイルを選択します。

以下のステップに従ってプロジェクトを構成します。

1. 64 ビットシステム用に構成するには、「Build」->「Configuration Manager」とクリックし、「Active Solution Platform」で「x64」を選択します。
2. プロジェクトを右クリックして「Properties」をクリックします。
3. 「Configuration」メニューで「All Configurations」を選択します。
4. 「Configuration Properties」->「General」->「Configuration Type」と進み、「Dynamic Library」を選択します。
5. 「Configuration Properties」->「C/C++」->「Code Generation」->「Enable C++ Exceptions」と進み、「No」を選択します。
6. 「Configuration Properties」->「C/C++」->「Advanced」->「Compile As」と進み、「Compile as C Code」を選択します。
7. 「Linker」->「Manifest File」->「Generate Manifest」と進み、「No」をクリックします。

以下のステップに従って必要な依存関係を追加します。

1. 「Linker」->「Input」->「Additional Dependencies」と進み、「Edit」を選択して以下を入力します。 postgres.lib libmysql.lib WS2_32.lib Secur32.lib さらに、「Inherit From Parent」または「Project Defaults」がチェックされていることを確認します。
2. 「Linker」->「General」->「Additional Library Directories」と進み、「Edit」を選択してPostgreSQL インストールのlib フォルダへのパスを追加します。
3. 「Linker」->「General」->「Link Library Dependencies」と進み、「No」を選択します。
4. プロジェクトの構成を完了するために必要なものを追加します。 「C/C++」->「General」->「Additional Include Directories」と進み、フォルダを次の順で追加します。 MyMySQLConnectorCInstallation\include MyPostgreSQLInstallation\MyPostgreSQLVersion\include\server\port\win32_msvc MyPostgreSQLInstallation\MyPostgreSQLVersion\include\server\port\win32 MyPostgreSQLInstallation\MyPostgreSQLVersion\include\server MyPostgreSQLInstallation\MyPostgreSQLVersion\include

Windows 用にmysql_fdw を構成する

プロジェクトを設定したら、Visual Studio でmysql_fdw を構築するために以下の変更を加えます。

1. mysql_fdw.c で以下の定義を追加します。 #define dlsym(lib, name) (void*)GetProcAddress((HMODULE)lib, name) #define dlopen(libname, unused) LoadLibraryEx(libname, NULL, 0)
2. mysql_load_library の定義で、以下の行を削除します。 mysql_dll_handle = dlopen(_MYSQL_LIBNAME, RTLD_LAZY | RTLD_DEEPBIND);
3. mysql_load_library の定義に次の行を追加して、Windows ビルド用のmysql_dll_handle の割り当てを置き換えます。 mysql_dll_handle = dlopen("libmysql.dll", 0);
4. mysql_fdw_handler 関数を呼び出す前に__declspec（dllexport）キーワードを付けてDLL から関数をエクスポートします。 __declspec(dllexport) extern Datum mysql_fdw_handler(PG_FUNCTION_ARGS);
5. option.c でmysql_fdw_validator 関数の宣言に__declspec（dllexport）キーワードを追加して、DLL から関数をエクスポートします。 __declspec(dllexport) extern Datum mysql_fdw_validator(PG_FUNCTION_ARGS);

これで、Release 構成とビルドを選択できるようになりました。

拡張機能をインストールする

DLL をコンパイルしたら次のステップに従って拡張機能をインストールします。

1. MySQL Connector C のlib フォルダへのパスをPostgreSQL を実行しているマシンのPATH 環境変数に追加します。
2. プロジェクトのRelease フォルダからPostgreSQL インストールのlib サブフォルダにDLL をコピーします。
3. mysql_fdw csource ファイルを含むフォルダで、myswl_fdw--1.0.sql とmysql_fdw.control を、PostgreSQL インストールの共有フォルダの下にある拡張フォルダにコピーします。例：C:\Program Files\PostgreSQL\9.4\share\extension.

PostgreSQL データベースとしてJSON データをクエリする

拡張機能をインストールしたら、次のステップに従ってJSON データへのクエリの実行を開始します。

1. PostgreSQL データベースにログインします。例： C:\> psql -U postgres
2. データベースの拡張機能をロードします。 postgres=#CREATE EXTENSION mysql_fdw;
3. JSON データのサーバーオブジェクトを作成します。 postgres=# CREATE SERVER JSON FOREIGN DATA WRAPPER mysql_fdw OPTIONS (host '127.0.0.1', port '3306');
4. MySQL リモートサービスが認識しているユーザーのユーザー名とパスワードにユーザーマッピングを作成します。以下は、サービスのサンプル構成におけるユーザーの資格情報です。 postgres=# CREATE USER MAPPING for postgres SERVER JSON OPTIONS (username 'admin', password 'test');
5. ローカルスキーマを作成します。 postgres=# CREATE SCHEMA JSON_db;
6. 定義したJSON データベースですべてのテーブルをインポートします。 postgres=# IMPORT FOREIGN SCHEMA "CData JSON Sys" FROM SERVER JSON INTO JSON_db;

これで、JSON へのread/write コマンドを実行することができるようになりました。

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

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

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