OData SDK for PHP を使ってCouchDB のデータを取得

CData Connect AI はCouchDB のデータをWeb サービスとして公開します。 この記事の手順を実行することで、CouchDB のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はCouchDB のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からCouchDB のデータへのリアルタイム連携を実現します。

Connect AI を構成

ODataPHP SDK でCouchDB のデータを操作するには、Connect AI からCouchDB に接続し、コネクションにユーザーアクセスを提供してCouchDB のデータのOData エンドポイントを作成する必要があります。

CouchDB に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でCouchDB に接続するユーザーを作成します。

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークンの追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

1. Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
2. 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
3. PAT の名前を入力して Create をクリックします。
4. パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からCouchDB に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect AI にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「CouchDB」を選択します。
3. 必要な認証プロパティを入力し、CouchDB に接続します。

   Apache CouchDB 接続プロパティの取得・設定方法

   それでは、Apache CouchDB に接続していきましょう。Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984

   ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするためにCData 製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

   Apache CouchDB への認証

   続いて、認証方法を設定しましょう。CData 製品では、3種類の認証をサポートしています。

   • Basic：基本的なユーザー名 / パスワード認証
   • JWT：JWT 認証
   • None：パブリックなデータベースへの匿名アクセス

   Basic 認証

   データに接続するには、以下のプロパティを設定してください。

   • AuthScheme：Basic
   • User：認証に使用されるApache CouchDB ユーザーアカウント
   • Password：認証するユーザーに関連付けられたApache CouchDB パスワード

   その他の認証方法については、ヘルプドキュメントの「接続の確立」セクションをご確認ください。

   
4. Create & Test をクリックします。
5. 「Add CouchDB Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にCouchDB OData エンドポイントを追加する

CouchDB に接続したら、目的のテーブルのOData エンドポイントを作成します。

1. OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
2. CouchDB 接続（例：ApacheCouchDB1）を選択し、Next をクリックします。
3. 使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、ODataPHP SDK からCouchDB のデータに接続できます。

1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\ApacheCouchDBEntities.php
   	    

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってCouchDB のデータにアクセスできます。以下のコードはMovies テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'ApacheCouchDBEntities.php';
   try{
     $svc = new CDataAPI();
     $movies = new Movies();
     $movies->MovieRating = 'R';
     $svc->AddToMovies($movies);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->movies()->Execute();
     foreach($response->Result as $movies)
       echo $movies->MovieRuntime."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }