PHP からHCL Domino のデータに接続する方法

CData ODBC Driver for Domino は、PHP アプリケーションからHCL Domino のデータへの連携を実現します。本記事では、HCL Domino のデータをPHP のビルトインODBC 機能でクエリする手順を説明します。

CData ODBC ドライバとは？

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

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

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

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

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

HCL Domino に接続するDSN を作成します。

1. まずODBC DSN に必要な接続プロパティの値を入力します。インストールが終わると、自動的にODBC DSN 設定画面が起動します。ODBC データソースアドミニストレータを使用してDSN を作成および設定する方法については、ヘルプドキュメントの「はじめに」の章を参照してください。
   
   

   Domino への接続

   それでは、Domino のデータに接続していきましょう。接続するには、以下のプロパティを設定してください。

   • URL：Domino データベースをホスティングしているサーバーのホスト名またはIP アドレス。Domino データベースをホスティングしているサーバーのポートを含めます。例：http://sampleserver:1234/
   • DatabaseScope：Domino Web UI でのスコープ名。CData 製品は、指定されたスコープに適合するスキーマのフォームとビューを公開します。Domino Admin UI で、サイドバーのScopes メニューを選択してください。このプロパティを既存のスコープ名に設定します

   Domino での認証

   続いて、認証方法を設定しましょう。Domino では、ログインクレデンシャル（OAuthPassword）またはMicrosoft Entra ID（AzureAD）のいずれかによる認証をサポートしています。

   ログインクレデンシャル

   ログインクレデンシャルで認証するには、以下のプロパティを設定してください：

   • AuthScheme：OAuthPassword
   • User：認証するDomino ユーザーのユーザー名
   • Password：認証するDomino ユーザーに関連付けられたパスワード

   ドライバーがログインクレデンシャルを使用して、自動的にOAuth トークン交換を実行します。

   Microsoft Entra ID（Azure AD）

   この認証方法は、Azure Active Directory をIdP として使用してJWT トークンを取得します。Azure Active Directory にカスタムのアプリケーションを作成し、それをIdP として設定する必要があります。詳しい手順については、ヘルプドキュメントの指示に従ってください。その後、以下のプロパティを設定します。

   • AuthScheme：AzureAD
   • InitiateOAuth：これをGETANDREFRESH に設定します。InitiateOAuth を使用すると、OAuth 交換の繰り返しやOAuthAccessToken の手動設定を避けることができます
   • OAuthClientId：カスタムAzure AD アプリケーションの作成時に取得したクライアントID
   • OAuthClientSecret：カスタムAzure AD アプリケーションの作成時に取得したクライアントシークレット
   • CallbackURL：カスタムAzure AD アプリケーションの登録時に指定されたリダイレクトURI。例えば、https://localhost:33333
   • AzureTenant：データにアクセスするために使用されるMicrosoft Online テナント。companyname.microsoft.com 形式の値またはテナントID のいずれかを指定してください

   テナントID は、Azure ポータルのAzure Active Directory > プロパティページに表示されているディレクトリID と同じです。

HCL Domino への接続の確立

odbc_connect を呼び出して、HCL Domino への接続を開きます。 odbc_pconnect メソッドでも可能です。コネクションを閉じるには、odbc_close もしくはodbc_close_all を使います。

$conn = odbc_connect("CData Domino Source","user","password");

コネクションはodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いたコネクションは、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトでコネクションを共有することが可能です:

$conn = odbc_pconnect("CData Domino Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

エレメントの作成

odbc_prepare を使って、Prepared ステートメントおよびパラメータライズドクエリを作成します。

$query = odbc_prepare($conn, "SELECT * FROM ByName WHERE City = ?");

クエリの実行

Prepared ステートメントをodbc_execute を使って実行します。

$conn = odbc_connect("CData Domino Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM ByName WHERE City = ?");
$success = odbc_execute($query, array('Miami'));
  

Non-Parameterized クエリは、odbc_exec を使います。

$conn = odbc_connect("CData Domino Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM ByName");
  

結果の処理

odbc_fetch_array ファンクションの結果セット配列としてアクセスします。

$conn = odbc_connect("CData Domino Source","user","password");
$query = odbc_exec($conn, "SELECT * FROM ByName");
while($row = odbc_fetch_array($query)){
 echo $row["Name"] . "\n";
}

odbc_result_all ファンクションで、結果セットをHTML テーブルとして表示します。

$conn = odbc_connect("CData Domino Sourcee","user","password");
$query = odbc_prepare($conn, "SELECT * FROM ByName WHERE City = ?");
$success = odbc_execute($query, array('Miami'));
if($success)
  odbc_result_all($query);

サンプルクエリのテスト

スタンドアロンのテスト環境をたちあげる簡単な方法はPHP のビルトインテストサーバーを使うことです。やっていきましょう。

1. PHP の最新版のバイナリのダウンロード。

2. フォルダにファイルを入れる。

3. フォルダを開く。

4. php.ini-development をphp.ini に変更。

5. ブラウザからテストスクリプトにアクセスするためのコマンドを実行。

   php -S localhost:8000 -t C:\path-to-your-scripts -c C:\path-to-php\php.ini
   

他のサンプルクエリ

サポートされているSQL の詳細は、ヘルプドキュメントを参照してください。上記のサンプルは、PHP のコミュニティドキュメントを参考に、HCL Domino 向けに最適化したものです。

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

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

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