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

CData Connect Server を使えば、OData を使ってCouchDB のデータにアクセスできます。CData Connect Server とOData PHP SDK を利用することで、CouchDB のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

加藤龍彦
デジタルマーケティング

最終更新日:2022-11-25

こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

CouchDB の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

  1. CData Connect Server にログインして、「DATA MODEL」をクリックします。 データベースを追加
  2. 利用できるデータソースアイコンから"CouchDB" を選択します。
  3. CouchDB に接続するために必要なプロパティを入力します。

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

    Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例:http://localhost:5984

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

    Apache CouchDB への認証

    3種類の認証をサポートします。
    • Basic:基本的なユーザー名 / パスワード認証。
    • JWT:JWT 認証。
    • None:パブリックなデータベースへの匿名アクセス。

    Basic 認証

    データに接続するには以下を設定します。

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

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

  4. 「Test Connection」をクリックします。
  5. 「USERS」 -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
  6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

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

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

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

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

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

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

    認証済みのユーザーは、CData Connect Server の管理コンソールの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 Server からのエラーをキャッチ echo $e->getError(), "\n"; }

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。