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

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

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

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

CData ODBC ドライバとは？

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

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

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

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

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

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

HubDBデータソースへの接続には、パブリックHubSpotアプリケーションを使用したOAuth認証とプライベートアプリケーショントークンを使用した認証の2つの方法があります。

カスタムOAuthアプリを使用する

すべてのOAuthフローでAuthSchemeを"OAuth"に設定する必要があります。特定の認証ニーズ（デスクトップアプリケーション、Webアプリケーション、ヘッドレスマシン）に必要な接続プロパティについては、ヘルプドキュメントを確認してください。

アプリケーションを登録し、OAuthクライアント認証情報を取得するには、以下の手順を実行してください。

1. HubSpotアプリ開発者アカウントにログインします。
   • アプリ開発者アカウントである必要があります。標準のHubSpotアカウントではパブリックアプリを作成できません。
2. 開発者アカウントのホームページで、アプリタブをクリックします。
3. アプリを作成をクリックします。
4. アプリ情報タブで、ユーザーが接続する際に表示される値を入力し、必要に応じて変更します。これらの値には、パブリックアプリケーション名、アプリケーションロゴ、アプリケーションの説明が含まれます。
5. 認証タブで、「リダイレクトURL」ボックスにコールバックURLを入力します。
   • デスクトップアプリケーションを作成する場合は、http://localhost:33333のようなローカルにアクセス可能なURLに設定します。
   • Webアプリケーションを作成する場合は、ユーザーがアプリケーションを承認した際にリダイレクトされる信頼できるURLに設定します。
6. アプリを作成をクリックします。HubSpotがアプリケーションとそれに関連する認証情報を生成します。
7. 認証タブで、クライアントIDとクライアントシークレットを確認します。これらは後でドライバーを設定する際に使用します。

8. スコープの下で、アプリケーションの意図する機能に必要なスコープを選択します。

   テーブルにアクセスするには、最低限以下のスコープが必要です：

   • hubdb
   • oauth
   • crm.objects.owners.read
9. 変更を保存をクリックします。
10. 統合に必要な機能にアクセスできる本番ポータルにアプリケーションをインストールします。
    • 「インストールURL（OAuth）」の下で、完全なURLをコピーをクリックして、アプリケーションのインストールURLをコピーします。
    • コピーしたリンクをブラウザで開きます。アプリケーションをインストールする標準アカウントを選択します。
    • アプリを接続をクリックします。結果のタブは閉じて構いません。

プライベートアプリを使用する

HubSpotプライベートアプリケーショントークンを使用して接続するには、AuthSchemeプロパティを"PrivateApp"に設定します。

以下の手順に従ってプライベートアプリケーショントークンを生成できます：

1. HubDBアカウントで、メインナビゲーションバーの設定アイコン（歯車）をクリックします。
2. 左サイドバーメニューで、統合 > プライベートアプリに移動します。
3. プライベートアプリを作成をクリックします。
4. 基本情報タブで、アプリケーションの詳細（名前、ロゴ、説明）を設定します。
5. スコープタブで、プライベートアプリケーションがアクセスできるようにしたい各スコープに対して読み取りまたは書き込みを選択します。
6. テーブルにアクセスするには、最低限hubdbとcrm.objects.owners.readが必要です。
7. アプリケーションの設定が完了したら、右上のアプリを作成をクリックします。
8. アプリケーションのアクセストークンに関する情報を確認し、作成を続行をクリックし、その後トークンを表示をクリックします。
9. コピーをクリックして、プライベートアプリケーショントークンをコピーします。

接続するには、PrivateAppTokenを取得したプライベートアプリケーショントークンに設定します。

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

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 データベースとしてHubDB のデータをクエリする

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

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

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

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

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

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